document-release

Synchronizes project docs with shipped changes and generates a Diataxis coverage map.

1|Updated May 27, 2026

Search Tags:#changelog #architecture #documentation #release #docs #diataxis

Ready to run

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

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what shipped; this skill automates syncing docs to reflect actual releases, reducing manual churn and surfacing debt for PR review.

Core Features & Use Cases

Reads project docs, cross-references diffs, and builds a Diataxis coverage map (reference/how-to/tutorial/explanation) to clarify documentation coverage.
Updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect shipped changes, detects architecture diagram drift, and polishes the changelog language.
Cleans up TODOS and optionally bumps the VERSION, surfacing documentation debt in PR bodies for review.

Quick Start

After a release, run this skill to align all shipped documents with the actual changes.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I automate post-release documentation updates to match shipped changes?▼

Automate post-release documentation updates by scanning code diffs and synchronizing core project docs like README and ARCHITECTURE to match shipped changes. This reduces manual churn by detecting drift and surfacing documentation debt directly in PR bodies for review.

What is the Diataxis framework coverage map and how does it help with documentation sync?▼

A Diataxis coverage map categorizes documentation into reference, how-to, tutorial, and explanation types to clarify coverage. Building this map during documentation sync helps identify gaps and ensures all shipped changes are accurately reflected across the appropriate explanatory formats.

How do I detect architecture diagram drift after a new release?▼

Detect architecture diagram drift by cross-referencing project diffs against existing documentation after a release. The skill scans these diffs to identify mismatches between shipped code changes and the diagrams in your ARCHITECTURE docs, surfacing them for review.

Can I update CONTRIBUTING and CLAUDE.md files automatically when shipping changes?▼

You can update CONTRIBUTING and CLAUDE.md files automatically by running the skill after a release. It scans your project diffs and applies localized text-editing capabilities to ensure these specific standard docs reflect the actual shipped changes.

Do I need external dependencies to synchronize changelogs and bump versions?▼

You do not need external dependencies to synchronize changelogs and bump versions. The skill operates with zero dependencies, requiring only local access to project docs and standard text-editing capabilities to polish changelog language and optionally bump the VERSION.

What is the best way to surface documentation debt in PR bodies?▼

Surface documentation debt in PR bodies by scanning post-ship diffs and identifying outdated TODOS or unpolished changelog entries. The skill cleans up these inconsistencies and compiles the remaining debt into the PR body for immediate review.