document-release

Updates project documentation to match shipped code changes after a release.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation (README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, TODOS) often drifts out of sync with what actually shipped. This Skill audits every doc against the release diff and brings them back into alignment. ## Core Features & Use Cases - Per-file documentation audit: Cross-references README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md against the git diff, classifying fixes as safe auto-updates or changes requiring user approval. - CHANGELOG voice polish and coverage mapping: Scores CHANGELOG entries with a sell-test rubric, builds a Diataxis coverage map (reference/how-to/tutorial/explanation), and detects architecture diagram drift. - Release bookkeeping: Cleans up TODOS.md, optionally bumps VERSION, commits doc changes, and updates the PR/MR body and title with a documentation debt summary. - Use Case: After merging a feature branch, run the post-ship docs pass to update the README feature list, polish the CHANGELOG entry, and surface undocumented new flags in the PR body. ## Quick Start Ask the assistant to update the docs and sync documentation for the changes shipped on this branch.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update project documentation after shipping code?

Run the post-ship docs workflow on your release branch. It reads the git diff, audits each documentation file against what changed, applies safe factual updates automatically, and asks before making narrative or structural changes.

What is a Diataxis documentation coverage map?

A Diataxis coverage map classifies documentation for each shipped feature into four quadrants: reference, how-to, tutorial, and explanation. The skill builds this map to surface gaps, such as a new command that has reference docs but no how-to guide.

Does this work with GitLab merge requests as well as GitHub PRs?

Yes. The workflow detects the platform and uses either the gh CLI for GitHub pull requests or glab for GitLab merge requests to update the PR/MR body with a Documentation section and sync the title version prefix.

Will it rewrite my CHANGELOG entries automatically?

No. The skill never deletes, reorders, or regenerates CHANGELOG entries. It only polishes wording within existing entries using exact-match edits, and asks via a prompt before any rewrite that could alter meaning.

When should I skip the VERSION bump during a docs update?

Skip the bump for docs-only changes, which is the recommended default. Bump PATCH only when doc changes ship alongside code, and MINOR for significant standalone releases. The skill always asks before bumping.