skills.rest
kitfunso
kitfunsoCOMMUNITY
Explore all skills by this author →
Website𝕏@keithso27GitHub

document-release

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

Updated May 22, 2026
Search Tags:#changelog#documentation#pull request#release#diataxis#git diff#version bump
One-click install
npx skills add https://github.com/kitfunso/claude-config --skill document-release-kitfunso
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/kitfunso/claude-config/tree/main/skills/document-release
Command: npx skills add https://github.com/kitfunso/claude-config --skill document-release-kitfunso

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project docs (README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, TODOS) drift 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 auto-updates or user-approved changes. - Diataxis coverage map: Builds a reference/how-to/tutorial/explanation coverage matrix for shipped features and surfaces documentation debt in the PR body. - CHANGELOG voice polish and VERSION bump: Scores CHANGELOG entries with a sell-test rubric without clobbering existing content, and asks before bumping VERSION. - Use Case: After merging a feature branch, run this Skill to update all docs, clean up TODOS.md, sync the PR title with the version, and commit the documentation changes. ## Quick Start Update the docs to match what shipped on this branch and surface any documentation debt 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 project documentation after shipping code?▼

Run this Skill after a PR is merged or code is shipped. It reads all project docs, cross-references them against the branch diff, applies factual auto-updates, and asks before making narrative or risky changes.

What documentation files does a post-ship docs update cover?▼

It audits 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 it work with GitLab merge requests as well as GitHub PRs?▼

Yes, it supports both platforms. It uses gh for GitHub and glab for GitLab to update the PR/MR body with a Documentation section and to sync the title with the current VERSION prefix.

Will it rewrite or delete my existing CHANGELOG entries?▼

No, it never clobbers CHANGELOG entries. It only polishes wording within existing entries using exact Edit matches, scores entries with a sell-test rubric, and asks via prompt if anything looks wrong.

Does it bump the VERSION file automatically?▼

No, it always asks before bumping VERSION. If VERSION was already bumped on the branch, it checks whether the bump covers the full scope of changes and prompts if significant changes are uncovered.

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 can be disabled entirely via gstack-config.

Related Skills

Explore More Software Engineering Skills→
GCWingGCWing
1.9k

document-release

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

Community
Advanced
Arize-aiArize-ai
11.3k

phoenix-docs-gap-audit

Audit recent commits against all Phoenix documentation surfaces to produce a grounded gap report.

Official
Advanced
zmh13928433602-syszmh13928433602-sys

review-checklist

Enforce a standardized PR review checklist covering correctness, security, testing, i18n, routing drift, reuse, and cloud impact.

Community
Intermediate
modu-aimodu-ai
1.2k

moai-docs-generation

Generates API references, user guides, and documentation sites using Sphinx, MkDocs, TypeDoc, and OpenAPI.

Official
Intermediate