document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping.

37|2|Updated Mar 28, 2026
One-click install
npx skills add https://github.com/DariusCorvus/iqualize --skill document-release-dariuscorvus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/DariusCorvus/iqualize/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/DariusCorvus/iqualize --skill document-release-dariuscorvus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship projects often drift in documentation. This Skill automatically updates and aligns docs after shipping, ensuring the README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md reflect what actually shipped, while polishing CHANGELOG voice and cleaning up TODOS. It helps teams maintain a reliable, user-facing documentation surface with minimal manual toil.

Core Features & Use Cases

  • Auto-syncs core docs to shipping changes by cross-referencing diffs.
  • Polishes CHANGELOG entries and bumps VERSION when needed.
  • Supports iterative documentation hygiene across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
  • Useful after PRs or releases to keep docs consistent with shipped code and decisions.

Quick Start

Run document-release after shipping to refresh all docs and open the PR with updated changes for review.

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 after shipping a release?

You can sync your CHANGELOG and core docs to your latest shipping changes by running an automated post-ship docs update. This process reads the diff, polishes the changelog voice, tidies TODOS, and optionally bumps your VERSION file.

What is the best way to keep README and ARCHITECTURE docs synced with shipped code changes?

Keeping documentation aligned after a PR requires cross-referencing the shipped diff and updating your README, ARCHITECTURE, and CLAUDE.md files accordingly. This prevents documentation drift and ensures user-facing surfaces match shipped code.

How do changelog and versioning automation tools handle post-ship documentation?

Changelog and versioning automation handles post-ship documentation by reading repository diffs, polishing the CHANGELOG voice, tidying TODOS, and optionally bumping the VERSION file alongside updating core documentation.

Can I automatically update CLAUDE.md and CONTRIBUTING files based on my git diff?

Yes, you can automatically update CLAUDE.md and CONTRIBUTING files based on your git diff. Automated documentation tools cross-reference shipped changes to apply repository-wide edits with safe validations across these specific files.

Do I need any external dependencies to automate repository-wide documentation edits?

No external dependencies are required to automate repository-wide documentation edits. The process orchestrates safe validations and file modifications using built-in tools like Bash, Read, Write, Edit, Grep, and Glob.

When should I avoid automating my post-release documentation sync?

You should avoid automating post-release documentation sync if your project lacks a clear diff to cross-reference or if your documentation requires manual narrative adjustments that exceed simple changelog polishing and TODO tidying.