document-release

Update project documentation to reflect shipped changes after a release.

5|1|Updated Feb 12, 2026

Search Tags:#architecture #documentation #claude #readme #diff-analysis #post-ship

Ready to run

npx skills add https://github.com/drt0927/tw-overlay --skill document-release-drt0927

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/drt0927/tw-overlay/tree/main/.gemini/skills/gstack-document-release
Command: npx skills add https://github.com/drt0927/tw-overlay --skill document-release-drt0927

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates drift as features ship and docs fall out of sync. This Skill reads all project docs, cross-references the shipped changes, and updates the relevant files to reflect what was released, reducing maintenance toil.

Core Features & Use Cases

Read and align README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped changes.
Polish CHANGELOG voice, clean up TODOS, and optionally bump VERSION to reflect a new release.
Automatically keep cross-document references consistent after a release and support post-ship audits.

Quick Start

Run document-release after a PR is merged to sync and polish the docs to shipped state.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I update README and ARCHITECTURE docs to match shipped code changes?▼

You can automate post-ship documentation alignment by scanning all project docs and cross-referencing diffs. This updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to accurately reflect the latest shipped features and modifications.

What is post-ship documentation alignment and when should I apply it?▼

Post-ship documentation alignment syncs project files with released code changes. You should apply it immediately after a PR is merged to prevent documentation drift and reduce maintenance toil across cross-document references.

How do I polish CHANGELOG entries and clean up TODOS after a release?▼

You can polish CHANGELOG voice and clean up TODOS by running an automated post-ship scan over your repository. This process refines release notes and optionally bumps the VERSION file to match the new state.

Can I sync project documentation automatically using Bash tooling?▼

Yes, you can sync project documentation automatically using Bash-based tooling. The process uses Read, Write, Edit, Grep, and Glob operations to scan diffs, apply changes to relevant docs, and report completion without manual intervention.

What are the limitations of automating documentation updates after a merge?▼

Automating documentation updates requires full repository access and depends on Bash-based tooling. It operates post-ship by cross-referencing diffs, meaning it requires an existing repository state and cannot generate documentation for uncommitted or unmerged code.