document-release

Update project documentation files to reflect shipped changes after PR merges.

Updated Mar 31, 2026
One-click install
npx skills add https://github.com/amanik/sailor-score-debug --skill document-release-amanik
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/amanik/sailor-score-debug/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/amanik/sailor-score-debug --skill document-release-amanik

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from shipped changes. document-release reads all project docs, cross-references diffs, and updates key files to match what shipped.

Core Features & Use Cases

  • Reads repository docs, cross-references diffs, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG language, cleans up TODOS, and optionally bumps VERSION when appropriate.
  • Proactively suggests documentation updates after PR merges or code ships.

Quick Start

Run the document-release skill after a ship to synchronize documentation across the repository.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I sync project documentation after merging a PR?

To sync project documentation after a PR merge, the skill cross-references shipped diffs and updates key files like README, ARCHITECTURE, and CONTRIBUTING to accurately reflect the latest changes. It ensures all post-ship docs stay perfectly aligned with the codebase.

What is the best way to update a CHANGELOG and clean up TODOS after a release?

The best way to update a CHANGELOG and clean TODOS after a release is using an automated documentation update process that polishes language and removes completed items. This skill handles those optional steps while synchronizing post-ship documentation across your repository.

How does cross-referencing diffs keep README and ARCHITECTURE docs in sync?

Cross-referencing diffs keeps README and ARCHITECTURE docs in sync by reading all project documentation, comparing it against shipped code changes, and automatically updating key files. This prevents post-ship documentation drift by ensuring every file matches the merged code.

Can I automatically bump VERSION and update CLAUDE.md when code ships?

Yes, you can bump VERSION and update CLAUDE.md when code ships. The skill optionally bumps the VERSION file when appropriate and ensures CLAUDE.md stays in sync alongside README and other key documentation files after a release.

Does this documentation update approach require any external dependencies?

No, this documentation update approach requires no external dependencies. It operates independently to cross-reference diffs, polish CHANGELOG language, and synchronize post-ship documentation across your repository without needing additional libraries or tools.

When should I not use automated post-ship documentation synchronization?

You should not use automated post-ship documentation synchronization for pre-ship staging or when manual narrative control over CHANGELOG language is strictly required. The skill is designed specifically for post-merge updates, proactively suggesting documentation changes after code has already shipped.