document-release

Reconcile shipped changes across core docs and polish the CHANGELOG.

Updated Feb 24, 2026
One-click install
npx skills add https://github.com/gaaschk/gaasch-family --skill document-release-gaaschk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/gaaschk/gaasch-family/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/gaaschk/gaasch-family --skill document-release-gaaschk

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation maintenance is tedious and error-prone. This Skill automates the process by reading shipped changes, updating core project docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect what was released, polishing the CHANGELOG language, tidying TODOS, and optionally bumping VERSION.

Core Features & Use Cases

  • Synchronizes README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to mirror shipped changes.
  • Polishes CHANGELOG wording and tidies TODOS to keep public docs accurate and readable.
  • Optionally bumps the VERSION when doc-related changes are released or after a PR merge.

Quick Start

Run the document-release skill to synchronize shipped docs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md and polish the CHANGELOG.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate documentation updates after a code shipment or PR merge?

Automating post-ship documentation updates involves reading shipped diffs to reconcile changes across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files. This ensures core project docs accurately mirror released code changes without manual editing.

What is the best way to keep a CHANGELOG and project docs in sync with shipped changes?

Keeping a CHANGELOG and project docs in sync requires reading shipped code diffs and applying those updates across core documentation files. This process polishes CHANGELOG wording, tidies TODOS, and optionally bumps the VERSION for traceability.

How does diff-based documentation reconciliation work for version control workflows?

Diff-based documentation reconciliation works by analyzing code changes from a shipment or PR merge, then applying those updates deterministically to README, ARCHITECTURE, and CONTRIBUTING docs. This safe update flow ensures consistency and traceability across project files.

Can I automatically bump the VERSION file when documentation changes are released?

Yes, you can automatically bump the VERSION file when doc-related changes are released or after a PR merge. This optional step occurs alongside synchronizing README, ARCHITECTURE, and other core docs to maintain accurate version tracking.

Do I need any external dependencies to synchronize post-ship documentation across multiple files?

No external dependencies are required to synchronize post-ship documentation. The process relies on deterministic tooling and safe update flows built into the skill to read diffs and apply updates across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Why does post-ship documentation maintenance become error-prone without automation?

Post-ship documentation maintenance becomes error-prone because manually updating README, ARCHITECTURE, and CONTRIBUTING files to reflect shipped changes invites inconsistencies. Automating diff reconciliation ensures core docs, CHANGELOG wording, and TODOS stay perfectly aligned with the released code.