What problem does it solve?
After code is shipped, project documentation like READMEs, CHANGELOGs, and architecture guides often fall out of sync with the actual shipped features, causing confusion for team members and new contributors. This Skill eliminates the tedious manual work of updating all project docs to match what was actually deployed.
Core Features & Use Cases
- Automated Doc Alignment: Cross-references recent code diffs to update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to reflect shipped changes.
- CHANGELOG Polish & Cleanup: Refines the voice of CHANGELOG entries and removes outdated TODO comments left in documentation.
- Optional Version Bumping: Automatically updates the project VERSION file to match the new release if needed.
- Use Case: After merging a PR that adds a new user authentication flow, run this Skill to automatically update the README to document the new flow, add the change to the CHANGELOG, and remove any outdated TODO comments about auth in the project docs.
Quick Start
Use the document-release skill to update all project documentation to match the changes from your most recent shipped code PR.