document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE after a release.

Updated Mar 28, 2026

Search Tags:#automation #workflow #changelog #documentation #claude #docs-sync #post-ship

Ready to run

npx skills add https://github.com/24601/gastack-pre-fork --skill document-release-24601

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/24601/gastack-pre-fork/tree/main/document-release
Command: npx skills add https://github.com/24601/gastack-pre-fork --skill document-release-24601

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift slows teams and reduces trust in the published state. This Skill automatically updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes, cross-referencing diffs and polishing the changelog voice.

Core Features & Use Cases

Automates post-ship doc synchronization across key docs to reflect the latest code, architecture decisions, and contribution guidelines.
Cross-references diffs, updates CHANGELOG entries, and polishes TODO annotations to keep the project documentation coherent after a release.
Proactively suggests when a docs bump is warranted and how to raise a PR to merge the changes into the main branch.

Quick Start

Run the document-release skill after shipping to align all project docs with the latest release.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I keep documentation in sync after a release?▼

Keeping documentation in sync after a release requires updating your README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files. This Skill automates that post-ship process by cross-referencing code diffs to ensure all project docs accurately reflect the newly shipped changes.

What is the best way to automate changelog updates and doc synchronization?▼

Automating changelog updates and doc synchronization is best handled by a post-ship workflow tool. This Skill reads frontmatter settings, coordinates optional version bumps, and polishes the changelog voice alongside your core documentation to maintain project coherence.

Can I use this to update CLAUDE.md and CONTRIBUTING files automatically?▼

Yes, you can update CLAUDE.md and CONTRIBUTING files automatically. The Skill targets these specific files alongside README and ARCHITECTURE docs, ensuring contribution guidelines and architecture decisions match the shipped codebase state.

When do I need to run post-ship documentation updates?▼

You need to run post-ship documentation updates immediately after shipping a release. The Skill proactively suggests when a docs bump is warranted and outlines how to raise a PR to merge the synchronized changes into your main branch.

Does this docs-sync workflow support automatic version bumps?▼

Yes, this docs-sync workflow supports automatic version bumps. It reads your frontmatter settings to coordinate optional version increments while simultaneously polishing TODO annotations and updating CHANGELOG entries to match the release state.

Why does my README drift after shipping new code changes?▼

Your README drifts after shipping because manual updates are often skipped during rapid releases. This Skill prevents post-ship documentation drift by cross-referencing shipped diffs and automatically applying those changes across all key project docs.