document-release

Updates README, CHANGELOG, and related docs to match shipped code changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts away from the code that actually shipped, leaving readers with stale setup steps, misleading architecture notes, and incomplete release notes. This Skill closes that gap by turning the latest diff into concrete documentation updates and a clear record of any remaining documentation debt.

Core Features & Use Cases

  • Audits README, ARCHITECTURE, CONTRIBUTING, CLAUDE, CHANGELOG, TODOS, and VERSION against the shipped changes.
  • Builds a Diataxis coverage map to spot missing reference, how-to, tutorial, or explanation coverage.
  • Updates factual documentation automatically while asking before risky narrative rewrites or version changes.
  • Can polish changelog voice, clean TODOs, sync PR or MR bodies, and commit the final documentation changes.
  • Use it after a merge, ship, or code release when docs need to match reality.

Quick Start

Use the document-release skill to review the latest diff and update the project documentation so it matches what shipped.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep release documentation in sync with shipped code changes?

To keep release documentation in sync with shipped code changes, you audit post-merge diffs against README and changelog files, apply controlled auto-edits, and commit the synchronized updates via a pull request.

What is the best way to update a changelog after a code release?

The best way to update a changelog after a code release is to analyze the latest diff, map factual changes to release notes, polish the changelog voice, and append entries that reflect what actually shipped.

How does Diataxis coverage mapping identify missing documentation?

Diataxis coverage mapping identifies missing documentation by categorizing existing repo files into tutorial, how-to, reference, and explanation quadrants, then highlighting gaps where the shipped diff lacks corresponding narrative updates.

Can I automatically update README and architecture docs after a merge?

Yes, you can automatically update README and architecture docs after a merge, but approval gates are required for risky narrative rewrites or version changes to prevent unauthorized factual drift in the repository.

Why does post-ship documentation drift away from the actual codebase?

Post-ship documentation drifts away from the actual codebase because manual updates are often skipped during fast releases, leaving stale setup steps and misleading architecture notes that fail to reflect recent diffs.

When should I use an approval gate for repository documentation updates?

You should use an approval gate for repository documentation updates when the diff analysis detects risky narrative rewrites, structural version changes, or modifications to core architecture files that require human review.