document-release

Scan changed files and update core docs to reflect shipped state.

Updated May 11, 2026
One-click install
npx skills add https://github.com/cloudofgeorge/AI-hands --skill document-release-cloudofgeorge
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/cloudofgeorge/AI-hands/tree/main/skills/gstack/document-release
Command: npx skills add https://github.com/cloudofgeorge/AI-hands --skill document-release-cloudofgeorge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from reality. This skill reads project docs, cross-references changes, and updates core files to reflect what shipped, including README, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md.

Core Features & Use Cases

  • Reconciles documentation with shipped changes across key files to keep teams aligned.
  • Detects architecture diagram drift, polishes the CHANGELOG voice, updates TODOS, and refreshes contributor notes.
  • Surface documentation debt in PR bodies and optionally bump the version.

Quick Start

After shipping, run the document-release skill to refresh documentation so it reflects the latest changes.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically update documentation after a release?

To update documentation after a release, you can scan changed files and cross-reference the diff to update core docs like README and ARCHITECTURE.md. This skill reconciles post-ship documentation by reading, comparing, and modifying files to reflect the shipped state.

Why does my architecture documentation drift from the shipped code?

Architecture documentation drifts because post-ship docs are rarely updated to match the latest code changes. This skill detects drift by scanning changed files and cross-referencing the diff to update architecture notes accurately.

Can I automatically polish my CHANGELOG and bump the version when merging?

Yes, you can polish your CHANGELOG and optionally bump the version during release- or merge-driven updates. This skill refines the changelog voice and applies version bumps while updating core documentation.

What is the best way to surface documentation debt in a PR body?

The best way to surface documentation debt in a PR body is to scan project diffs and generate a concise report of what changed. This skill compares shipped changes against existing docs and highlights the debt in your PR descriptions.

Do I need any specific dependencies to synchronize docs with shipped changes?

You do not need specific dependencies to synchronize docs with shipped changes. This skill relies on Bash and common CLI tools to read, compare, and modify files, requiring no external packages to function.