document-release

Update project docs to reflect shipped changes after PR merges.

Updated Apr 1, 2026

Search Tags:#changelog #architecture #documentation #readme #diff #post-ship

Ready to run

npx skills add https://github.com/whd4/gstack --skill document-release-whd4

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift: teams ship features without aligning docs, which leads to stale README files, outdated ARCHITECTURE notes, diverging CONTRIBUTING guidelines, and unclear CLAUDE.md instructions. This skill automates cross-referencing shipped changes against project docs to keep core docs consistent and up-to-date.

Core Features & Use Cases

Cross-reference: reads diffs from the latest ship and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to mirror shipped changes.
Documentation polish: refines CHANGELOG voice and cleans up TODOS to reflect the current state.
Version bump: optionally bumps the repository VERSION when the ship introduces a new release.

Quick Start

After a PR is merged, run the document-release skill to synchronize docs with shipped changes.

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 ARCHITECTURE docs after a PR merge?▼

To automatically update README and ARCHITECTURE docs after a PR merge, run the document-release skill to cross-reference shipped diffs and apply deterministic edits to mirror the changes across your project files.

What is the best way to keep documentation aligned with shipped code changes?▼

Keeping documentation aligned with shipped code changes involves cross-referencing project diffs against existing docs to prevent documentation drift, ensuring README, ARCHITECTURE, and CONTRIBUTING files accurately reflect the latest features.

Can I automatically polish the CHANGELOG and clean up TODOS when shipping a new version?▼

Yes, you can automatically polish the CHANGELOG and clean up TODOS when shipping a new version by running the document-release skill, which refines the changelog voice and optionally bumps the repository VERSION.

How do I prevent CLAUDE.md instructions from diverging after merging new features?▼

To prevent CLAUDE.md instructions from diverging after merging new features, automate post-ship documentation alignment by loading diffs into context and applying deterministic edits to keep instructions consistent.

Does this documentation update process work for any repository with a VERSION file?▼

Yes, the documentation update process works for any repository with a VERSION file, using Bash, Read, Write, and Grep commands to load changes into context and optionally bump the version across the repository after shipping.

When should I use an automated post-ship documentation tool instead of manual edits?▼

You should use an automated post-ship documentation tool instead of manual edits when teams frequently ship features without aligning docs, leading to stale README files, outdated ARCHITECTURE notes, and diverging CONTRIBUTING guidelines.