document-release

Update project docs to reflect shipped changes after release.

4|2|Updated Mar 29, 2026
One-click install
npx skills add https://github.com/florianhorner/mammamiradio --skill document-release-florianhorner
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/florianhorner/mammamiradio/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/florianhorner/mammamiradio --skill document-release-florianhorner

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what was shipped. document-release reads the project docs, cross-references the shipped changes, and updates critical files to reflect what actually went out, delivering a coherent documentation baseline after a release.

Core Features & Use Cases

  • Reads all project docs and cross-references the diff to identify drift between shipped code and documentation.
  • Updates essential docs like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to mirror shipped changes, polishes the CHANGELOG wording, cleans TODOS, and optionally bumps VERSION.
  • Use after PR merges or releases to ensure documentation stays authoritative and aligned with the shipped product.

Quick Start

Run document-release after shipping to synchronize and polish 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 sync documentation with shipped code changes after a release?

To sync documentation with shipped code, run the document-release process after a merge. It cross-references project diffs against existing docs, updates README and ARCHITECTURE files, and polishes the CHANGELOG to reflect the actual release.

What is the best way to update a CHANGELOG and CLAUDE.md after shipping?

Updating a CHANGELOG and CLAUDE.md after shipping is best handled by a post-ship diff detection process. It reads project docs, cross-references shipped changes, polishes changelog wording, and aligns CLAUDE.md to prevent documentation drift.

When should I run post-ship documentation hygiene?

You should run post-ship documentation hygiene immediately after a release or PR merge. This ensures your README, CONTRIBUTING, and ARCHITECTURE docs are updated to match the shipped product before development continues.

Does document-release work without external dependencies?

Yes, post-ship documentation synchronization works without external dependencies. It reads project files directly, identifies drift between shipped code and documentation, and updates core docs like CLAUDE.md and README automatically.

Can I automatically bump the VERSION while syncing project docs?

Yes, you can automatically bump the VERSION while syncing project docs. The post-ship documentation process includes an optional version bump alongside cleaning TODOS and updating essential files to mirror shipped changes.

Why does my README drift from the shipped product after merges?

Your README drifts from the shipped product because post-merge documentation updates are often skipped. A diff-detection process cross-references shipped changes against project docs to automatically update README, ARCHITECTURE, and CONTRIBUTING files.