document-release

Update project docs to match shipped code changes.

Updated Apr 25, 2026
One-click install
npx skills add https://github.com/uzumaki-inc/uzustack --skill document-release-uzumaki-inc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/uzumaki-inc/uzustack/tree/main/_upstream/gstack/document-release
Command: npx skills add https://github.com/uzumaki-inc/uzustack --skill document-release-uzumaki-inc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift can lead to inconsistent project narratives and confusion. This skill reads project docs, cross-references the shipped changes, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what was actually shipped.

Core Features & Use Cases

  • Documentation sync: automatically aligns docs with released changes to reduce manual edits.
  • Changelog polishing: keeps CHANGELOG and related notes aligned with the ship cycle.
  • Consistency across docs: ensures CLAUDE.md and architecture references describe the current state after shipping.

Quick Start

Run the document-release skill after merging a release to synchronize all 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 keep documentation synchronized with shipped code changes automatically?

To keep documentation synchronized with shipped code changes, you can automate post-ship updates that diff released code against current docs and update text accordingly. This ensures README, ARCHITECTURE, and CLAUDE.md reflect the actual shipped state.

What is the best way to update README and ARCHITECTURE files after a release?

The best way to update README and ARCHITECTURE files after a release is running an automated documentation sync workflow. It cross-references shipped changes with existing project docs and applies targeted edits to keep project narratives consistent.

How does automated post-ship documentation drift prevention work?

Post-ship documentation drift prevention works by reading project docs, cross-referencing recently merged changes, and using deterministic Bash, Read, Write, and Edit tools to update text. This aligns CHANGELOG and architecture references with the current ship cycle.

Can I use this to align CLAUDE.md with my latest code release?

Yes, you can align CLAUDE.md with your latest code release. The skill ensures CLAUDE.md and architecture references describe the current state after shipping by diffing shipped code against current docs and applying necessary text updates.

Do I need specific dependencies to automate changelog polishing and doc updates?

No specific dependencies are required to automate changelog polishing and doc updates. The skill relies on standard SKILL.md frontmatter for configuration and uses built-in Bash, Read, Write, and Edit tools to execute a deterministic documentation update workflow.

When should I not use automated documentation sync for my project?

You should not use automated documentation sync when your project lacks established core docs like README or ARCHITECTURE files, as the tool requires existing documentation to diff against shipped code changes and apply targeted text edits.