document-release

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

1|Updated Jul 23, 2026
One-click install
npx skills add https://github.com/sanjanb/my-agent-harness --skill document-release-sanjanb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/sanjanb/my-agent-harness/tree/main/skills/document-release
Command: npx skills add https://github.com/sanjanb/my-agent-harness --skill document-release-sanjanb

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 file against the release diff and brings documentation back in line with reality. ## Core Features & Use Cases - Per-file documentation audit: Cross-references README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md against the git diff, classifying fixes as auto-updates or user-confirmed changes. - Diataxis coverage map: Builds a reference/how-to/tutorial/explanation coverage matrix and surfaces documentation debt in the PR body. - CHANGELOG voice polish: Scores entries with a sell-test rubric and rewrites commit-message-style entries without ever clobbering existing content. - Release hygiene: Cleans up TODOS.md, optionally bumps VERSION, syncs the PR title, and runs an independent Codex or Claude cross-model doc review. - Use Case: After merging a feature branch, run this Skill to update all docs, polish the CHANGELOG, and append a documentation debt summary to the PR body before release. ## Quick Start Update all project documentation to match what shipped on this branch and surface any documentation gaps in the PR body.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update documentation after shipping code?

Run the document-release skill after a PR is merged or code is shipped. It reads the branch diff, audits each documentation file against what changed, applies factual auto-updates, and asks before making narrative or structural changes.

What documentation files does a post-release doc audit cover?

The audit covers README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, CHANGELOG.md, TODOS.md, and VERSION. It also checks cross-doc consistency and whether every doc is discoverable from README or CLAUDE.md.

Does the skill rewrite or delete existing CHANGELOG entries?

No. The skill never deletes, reorders, or regenerates CHANGELOG entries. It only polishes wording within existing entries using exact-match edits, and asks via AskUserQuestion if an entry looks wrong or incomplete.

Will the version number be bumped automatically?

No. The VERSION bump always requires explicit user confirmation through AskUserQuestion. If VERSION was already bumped, the skill checks whether the bump covers all shipped changes before suggesting another one.

What happens if the Codex CLI is not installed for the doc review?

The cross-model documentation review falls back to a Claude subagent when Codex is not installed or not authenticated. The review is informational and non-blocking, and it can be disabled entirely with gstack-config set codex_reviews disabled.