document-release

Updates project documentation files to match shipped code changes after a release.

Updated Mar 23, 2026
One-click install
npx skills add https://github.com/dhnpmp-tech/project-agent --skill document-release-dhnpmp-tech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/dhnpmp-tech/project-agent/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/dhnpmp-tech/project-agent --skill document-release-dhnpmp-tech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation like README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG often drifts out of sync with what actually shipped. This Skill audits every documentation file against the branch diff and brings them back into alignment before the PR merges. ## Core Features & Use Cases - Diff-driven doc audit: Reads all Markdown docs in the repo and cross-references them against the git diff to find stale features, paths, counts, and commands. - Auto-update with guardrails: Applies clear factual corrections directly while asking the user before narrative, security, or large-rewrite changes. - CHANGELOG voice polish: Rewords existing entries to be user-forward without ever deleting or regenerating content, and checks VERSION bump coverage. - Use Case: After merging a feature branch that added a new CLI command, run this Skill to update the README feature table, fix the CONTRIBUTING setup steps, polish the CHANGELOG entry, and commit the doc updates to the PR. ## Quick Start Ask the assistant to run the document-release workflow to sync all project documentation with the changes on the current feature branch.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update project documentation after shipping code?

Run the document-release workflow from a feature branch after code is committed. It reads every Markdown doc, cross-references the git diff, auto-applies factual corrections, and asks before risky narrative changes, then commits the updates to the PR.

How to keep README and CHANGELOG in sync with a release?

This workflow audits README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md against the branch diff, polishes CHANGELOG wording without altering entries, and verifies the VERSION bump covers all shipped changes before committing.

Does document-release work without a GitHub pull request?

Yes, the documentation audit and commit steps work without a PR. If no PR exists, the PR body update step is skipped with a message, and the doc changes remain in the commit on the current branch.

Will it rewrite or delete my CHANGELOG entries?

No. The skill only polishes wording within existing CHANGELOG entries using exact-match edits. It never deletes, reorders, replaces, or regenerates entries, and asks the user if an entry looks wrong or incomplete.

When should I not run the document-release workflow?

Do not run it from the base branch, since it aborts there by design. It is intended to run after code is shipped on a feature branch but before the PR merges, not as a general-purpose doc writer.