document-release

Audit project docs against a diff and update key documentation files.

Updated Jun 18, 2026

Search Tags:#changelog #documentation #audit #claude #diff #docs

Ready to run

npx skills add https://github.com/abhishekmmgn/didactic-invention --skill document-release-abhishekmmgn

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from the actual code and decisions. This skill audits shipped changes by reading the diff, builds a Diataxis coverage map, and updates key project docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, CHANGELOG) to reflect what shipped, ensuring consistency and reducing manual toil.

Core Features & Use Cases

Reads the project docs and cross-references the diff to identify mismatches between shipped code and documentation.
Builds a Diataxis coverage map (reference/how-to/tutorial/explanation) and updates the docs to align with shipped changes.
Detects architecture diagram drift and polishes the CHANGELOG voice; cleans up TODOS; optionally bumps VERSION; surfaces documentation debt in the PR body.

Quick Start

Initiate the document-release skill after a ship to audit docs and push aligned updates across project documentation.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I automatically update documentation after shipping code changes?▼

The document-release skill audits documentation drift by reading project docs, cross-referencing the code diff, and updating README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG to reflect shipped changes.

What is a Diataxis coverage map and how does it help with documentation audits?▼

A Diataxis coverage map categorizes documentation into reference, how-to, tutorial, and explanation types. The skill builds this map to identify mismatches between shipped code and documentation, ensuring comprehensive coverage of project updates.

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

To detect architecture diagram drift after a release, the skill cross-references the shipped diff against existing project docs and surfaces inconsistencies, including diagram drift, directly in the PR body as documentation debt.

Can I automatically bump VERSION and polish CHANGELOG entries when shipping?▼

Yes, you can automatically bump VERSION and polish CHANGELOG entries when shipping. The skill optionally bumps the VERSION file, refines the CHANGELOG voice, and cleans up TODOS during the post-ship documentation audit.

How do I surface documentation debt in a PR body?▼

To surface documentation debt in a PR body, the skill audits all project docs against the diff, detects mismatches like architecture diagram drift, and appends a summary of this debt directly into the PR body.

Do I need any specific dependencies to run the document-release skill?▼

No specific dependencies are required to run the document-release skill. It operates independently to read project docs, build a Diataxis coverage map, and update key documentation files based on the shipped diff.