What problem does it solve?
After a ship, project documentation often drifts out of date. This skill ensures docs reflect what shipped by reading diffs and updating key docs (README, ARCHITECTURE, CONTRIBUTING, AGENTS.md), polishing CHANGELOG language, cleaning up TODOS, and optionally bumping the VERSION. It keeps teams aligned and speeds onboarding by maintaining accurate documentation after every release.
Core Features & Use Cases
- Reads project docs and cross-references shipped changes against the diff to identify what needs updating.
- Updates README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md to reflect the shipped state and adds or adjusts content as needed.
- Polishes CHANGELOG language for clarity and consistency.
- Cleans up TODOS to reflect current work and removes stale items.
- Optionally bumps the VERSION to reflect new release state.
- Proactively suggests documentation updates after a PR is merged or code is shipped to prevent drift.
Quick Start
Run the document-release skill after shipping to synchronize docs with the latest changes.