document-release

Audits and auto-updates documentation consistency based on Git branch diffs before merge.

Updated Aug 27, 2026

Search Tags:#automation #changelog #documentation #audit #diff-analysis #docs-maintenance #pr-prep

Ready to run

npx skills add https://github.com/tak-bro/claude-code --skill document-release-tak-bro

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/tak-bro/claude-code/tree/main/skills/document-release
Command: npx skills add https://github.com/tak-bro/claude-code --skill document-release-tak-bro

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common: after code changes, docs can become outdated or inconsistent. This Skill audits all project documentation against the branch diff, auto-fixes factual updates, and asks about risky or subjective changes to ensure a clean, accurate release narrative.

Core Features & Use Cases

Auto-audit documentation across core files (README, ARCHITECTURE.md, CONTRIBUTING.md, CHANGELOG.md) and cross-doc references.
Auto-fix factual updates directly while surfacing risky or ambiguous changes for human review.
Ensure cross-document consistency and prepare PR-ready updates with a clean CHANGELOG narrative.
Pre-merge readiness checks that verify docs reflect current code changes and release context.

Quick Start

Run the document-release workflow on a branch with doc changes to automatically audit, update, and prepare a PR-ready documentation update.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I automate documentation updates before merging a pull request?▼

Pre-merge documentation audits identify drift by comparing branch diffs against project docs, auto-fixing factual updates, and flagging risky changes for human review. This prevents outdated or inconsistent release narratives from reaching production.

Can I automatically fix cross-document inconsistencies in my project docs?▼

Cross-document consistency checks compare references across README, ARCHITECTURE.md, CONTRIBUTING.md, and CHANGELOG.md. The audit directly auto-fixes factual updates while surfacing ambiguous changes for manual review.

What is the best way to generate a clean CHANGELOG from code changes?▼

Polishing a CHANGELOG narrative involves analyzing the branch diff to ensure accurate release context. The audit verifies that CHANGELOG entries reflect current code changes and cross-doc references before preparing PR-ready updates.

Does this documentation audit work on committed changes only or uncommitted code?▼

This documentation audit operates exclusively on changes committed before merging pull requests. It uses the committed branch diff to apply factual fixes, flag risky modifications, and verify cross-document consistency.

How do I perform a diff analysis to find outdated documentation?▼

Diff analysis for outdated documentation involves comparing project docs against the committed branch diff to identify factual drift. The audit auto-updates discrepancies and flags risky modifications for human review.

What should I do when a documentation audit flags risky changes?▼

When a documentation audit flags risky changes, it prompts for human review before applying updates. This ensures ambiguous or subjective modifications are manually verified to maintain an accurate release narrative.