document-release

Scan shipped changes and update project documentation files.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/TwoToned/gearflow --skill document-release-twotoned
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/TwoToned/gearflow/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/TwoToned/gearflow --skill document-release-twotoned

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts out of date as code changes ship. This Skill automates a post-release documentation update by reading diffs and aligning README/ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and CHANGELOG with shipped changes, ensuring the publicly visible docs reflect the current state.

Core Features & Use Cases

  • Reads project diffs after ship and identifies affected docs.
  • Updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to match shipped changes; polishes CHANGELOG language; cleans up TODOS; optionally bumps the VERSION.
  • Proactively suggests and applies documentation updates after PR merges or code shipments.

Quick Start

Invoke the document-release skill after shipping to refresh and align all project docs with the latest changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-ship documentation updates after merging code changes?

Automating post-ship documentation updates involves scanning shipped diff changes and modifying README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG files to reflect the latest project state.

Does this documentation sync tool update CLAUDE.md and CHANGELOG automatically?

Yes, this documentation sync tool updates CLAUDE.md and polishes CHANGELOG language automatically by parsing project diffs to align file content with shipped changes.

Can I use this to bump the project VERSION file during the release process?

Yes, you can use this to bump the project VERSION file during the release process, as it optionally applies version bumps while synchronizing post-ship documentation edits across multi-file repositories.

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

The best way to keep README and ARCHITECTURE docs aligned with shipped code is to parse diffs post-release and apply automated edits to update Markdown front matter and content.

Do I need a multi-file repository to run post-ship documentation synchronization?

Yes, you need a multi-file repository to run post-ship documentation synchronization, because the Skill scans shipped changes across multiple files to update project docs accurately.

Why does my project documentation drift out of date after shipping code?

Project documentation drifts out of date after shipping code because manual updates are often skipped, making automated post-release diff parsing necessary to refresh and align all project docs.