document-release

Update project documentation files to reflect shipped changes.

Updated Apr 5, 2026
One-click install
npx skills add https://github.com/GTC6244/ToolBridge --skill document-release-gtc6244
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/GTC6244/ToolBridge/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/GTC6244/ToolBridge --skill document-release-gtc6244

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship projects frequently drift as docs lag behind changes. This skill reads the latest project docs, cross-references the shipped changes, and ensures README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md stay accurate, polished, and aligned with the current state of the codebase.

Core Features & Use Cases

  • Read project docs and identify diffs introduced by the ship.
  • Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
  • Polish CHANGELOG language and clean up TODOS; optionally bump the version.

Quick Start

Run the document-release skill after a PR merge or ship to automatically reconcile the documentation with the shipped changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update documentation after shipping code changes?

To update documentation after shipping, scan the project diffs and cross-reference them with existing files. This skill reads the latest docs, identifies shipped changes, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the current codebase accurately.

What is the best way to polish a CHANGELOG after a release?

The best way to polish a CHANGELOG after a release is to cross-reference shipped diffs against existing docs. This skill scans changes, cleans up TODOS, polishes the CHANGELOG language, and optionally bumps the version while prompting for user confirmation.

Does this docs update workflow require manual file edits?

This docs update workflow does not require manual file edits. It performs edits automatically via Bash, reads, and writes, but prompts for user confirmation when routing changes to ensure you maintain control over the documentation updates.

How does CLAUDE.md synchronization work after a PR merge?

CLAUDE.md synchronization works by scanning diffs introduced by the PR merge and cross-referencing them with current project docs. The skill then updates CLAUDE.md and other documentation files to align with the shipped codebase changes.

When do I need to update ARCHITECTURE docs post-ship?

You need to update ARCHITECTURE docs post-ship when merged changes introduce structural diffs. This skill reads the project diffs and automatically reconciles the ARCHITECTURE documentation to prevent post-ship project drift.