document-release

Name: document-release
Availability: InStock
Author: scanbott

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping code releases.

Updated Apr 21, 2026

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

Ready to run

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

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates can drift as code ships and docs get out of sync. This skill reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match 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

Synchronizes documentation across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
Polishes CHANGELOG language and cleans up TODOS.
Optionally bumps VERSION when appropriate as part of post-ship hygiene.
Proactively suggests documentation updates after PRs or code shipments.

Quick Start

Run the document-release skill after a PR merge to align shipped changes with project docs.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I update project documentation after shipping a code change?▼

To update project documentation after shipping, this skill reads code diffs and applies matching changes to README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files. It scans the shipped diff, validates the changes, and synchronizes all related docs automatically.

What is the best way to keep CLAUDE.md and CHANGELOG files in sync with merged PRs?▼

Keeping CLAUDE.md and CHANGELOG files in sync after a PR merge involves reading the latest diffs and applying updates across all project docs. This skill polishes CHANGELOG language, cleans up TODOS, and updates CLAUDE.md to accurately reflect what shipped.

Can I automatically bump the VERSION file when syncing documentation post-ship?▼

Yes, you can automatically bump the VERSION file as part of post-ship documentation synchronization. The skill optionally bumps the VERSION file alongside updating README and other docs to maintain project hygiene after a shipment.

When should I use a post-ship documentation synchronization tool?▼

You should use a post-ship documentation synchronization tool whenever a PR is merged or code is shipped and your project docs risk drifting. It cross-references the diff to update README, ARCHITECTURE, and CONTRIBUTING files to match the new codebase.

Does the document-release skill require any external dependencies to scan diffs?▼

No external dependencies are required to scan diffs and update documentation. The skill operates autonomously using standard Bash, Read, Write, and Edit tooling to scan code diffs, validate changes, and apply updates across project documentation files.

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

To clean up TODOS and polish CHANGELOG language after a release, the skill scans the shipped diff and proactively refines the CHANGELOG text. It removes stale TODOS and ensures all documentation reflects the current state of the project.