document-release

Update project documentation files to reflect shipped code changes.

Updated Apr 3, 2026
One-click install
npx skills add https://github.com/Intension-us/attention-diagnostic --skill document-release-intension-us
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Intension-us/attention-diagnostic/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/Intension-us/attention-diagnostic --skill document-release-intension-us

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are error-prone and time-consuming. document-release reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when asked to "update the docs", "sync documentation", or "post-ship docs". Proactively suggest after a PR is merged or code is shipped. (gstack)

Core Features & Use Cases

  • Automated post-ship doc alignment across key files to reflect shipped changes.
  • CHANGELOG polishing, todo cleanup, and optional version bump.
  • Proactive documentation suggestions after code shipping or PR merge.

Quick Start

Tell Claude to run document-release after shipping to automatically sync docs across the repo.

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 README and CHANGELOG after shipping code?

Automatically update README and CHANGELOG after shipping by cross-referencing the git diff. The Skill reads project docs, reflects shipped changes across key files, polishes CHANGELOG voice, and cleans up TODOS.

What is post-ship documentation sync and when do I need it?

Post-ship documentation sync aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped code changes. You need it immediately after a PR merge to prevent documentation drift and keep the CHANGELOG accurate.

How to polish CHANGELOG voice and clean up TODOS after a release?

Polish CHANGELOG voice and clean up TODOS by analyzing the shipped diff and updating documentation files. The Skill refines the CHANGELOG narrative tone and removes obsolete TODO items to reflect the current codebase state.

Can I automatically bump the VERSION file when updating project documentation?

Yes, you can automatically bump the VERSION file when updating project documentation. The Skill optionally increments the version number alongside syncing README, ARCHITECTURE, and CONTRIBUTING files when asked to run post-ship docs.

Does this automated documentation sync work without external dependencies?

Yes, automated documentation sync works without external dependencies. The Skill reads all project docs and cross-references the diff internally to update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md without requiring additional packages.

What is the best way to keep architecture documentation in sync with code changes?

The best way to keep architecture documentation in sync is cross-referencing the code diff against existing docs. The Skill updates ARCHITECTURE.md and other key files to accurately reflect what shipped, eliminating manual post-ship updates.