document-release

Name: document-release
Availability: InStock
Author: chriswestt

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping changes.

Updated Apr 21, 2026

Search Tags:#documentation #diff #README #CLAUDE.md #CHANGELOG #version-bump #post-ship

Ready to run

npx skills add https://github.com/chriswestt/claude-skills --skill document-release-chriswestt

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping, teams must update documentation to reflect what changed. This skill reads the project docs, cross-references the diff, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match shipped changes.

Core Features & Use Cases

Cross-checks shipped changes against docs and fixes up README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
Polishes CHANGELOG language, cleans up TODOS, and can bump the project VERSION when needed.
Proactively suggests updates after a PR merge or code shipment to keep docs in sync.

Quick Start

Run the post-ship doc sync to align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md 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 update documentation after shipping a release?▼

Update documentation after shipping by reading current docs, cross-referencing code diffs, and modifying README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped changes.

How do I sync my README with recent code changes?▼

Sync your README by cross-referencing shipped code diffs against existing documentation content and applying updates to align the README with the latest release.

Can I automatically polish CHANGELOG language and clean up TODOs?▼

Yes, you can automatically polish CHANGELOG language and clean up TODOs during the post-ship documentation sync process to ensure project files remain accurate.

What is the best way to keep CLAUDE.md updated after a merge?▼

Keep CLAUDE.md updated after a merge by proactively suggesting documentation syncs that cross-reference the merged diff and apply necessary changes to the project files.

Do I need to manually specify file paths to sync post-ship docs?▼

No, you do not need to manually specify paths; the process automatically targets README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md when triggered by a request to update the docs.

Can I bump the project version when syncing documentation?▼

Yes, you can optionally bump the project VERSION when running the post-ship documentation sync to ensure versioning matches the shipped release.