document-release

Synchronize and polish project documentation after code shipments.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping, project documentation often drifts. This skill reads all project docs, cross-references the diff, and updates key files to reflect what shipped.

Core Features & Use Cases

  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes
  • Polishes CHANGELOG voice, cleans TODOS, and can bump VERSION when requested
  • Proactively suggests and guides after PR merges or code shipments

Quick Start

Run the document-release skill after a merge to refresh and polish project documentation.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep project documentation in sync after a code shipment?

To keep documentation in sync after shipping, you can automate the synchronization process by reading project diffs and applying updates to key files like README, ARCHITECTURE, and CLAUDE.md to accurately reflect the merged changes.

What is the best way to update a CHANGELOG and clean up TODOS after a PR merge?

The best way to update a CHANGELOG and clean TODOS after a PR merge is to trigger a post-ship workflow that polishes the CHANGELOG voice, removes completed TODOS, and optionally bumps the VERSION across your project documentation.

How does cross-referencing code diffs improve post-ship documentation updates?

Cross-referencing code diffs improves post-ship updates by identifying exactly what changed in the source, enabling targeted and accurate reflections of those shipped modifications across multiple key project documentation files.

Can I automatically update CLAUDE.md and ARCHITECTURE files when I merge code?

Yes, you can automatically update CLAUDE.md and ARCHITECTURE files after merging code by running a structured post-ship workflow that reads all project docs and proactively applies necessary improvements based on the shipped diff.

Does this documentation sync workflow require any external dependencies?

No, this documentation sync workflow does not require any external dependencies, allowing you to directly execute the post-ship updates and diff detection within your current project environment without additional setup.