document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after a ship.

Updated Mar 30, 2026
One-click install
npx skills add https://github.com/ArroganceG/trae_skills_backup --skill document-release-arroganceg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ArroganceG/trae_skills_backup/tree/main/document-release
Command: npx skills add https://github.com/ArroganceG/trae_skills_backup --skill document-release-arroganceg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are error-prone when diffs across multiple files aren’t reconciled. This Skill ensures that README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md reflect shipped changes, polishes the CHANGELOG voice, cleans up TODOS, and can bump VERSION when configured.

Core Features & Use Cases

  • Synchronizes key project docs after a ship or PR merge to reflect the exact shipped changes.
  • Proactively polishes documentation voice and consistency across core docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md).
  • Manages changelog polish and TODOS hygiene, with optional automatic VERSION bump.

Quick Start

Invoke document-release after a ship to synchronize and polish all 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 synchronize project documentation after merging a PR?

To synchronize project documentation after a PR merge, you need to update key docs to reflect the shipped changes. This ensures files like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md stay consistent and accurately describe the new codebase state.

What is the best way to keep README and ARCHITECTURE docs consistent across versions?

Keeping README and ARCHITECTURE docs consistent across versions requires enforcing cross-document consistency after every ship. By reconciling file diffs and polishing documentation voice, you prevent post-ship updates from becoming error-prone and drifting out of sync.

How do I automatically bump VERSION and update the CHANGELOG after a release?

You can bump VERSION and update the CHANGELOG after a release by triggering a post-ship documentation synchronization. This process cleans up TODOS, polishes the changelog voice, and optionally applies an automatic version bump when configured.

Can I trigger documentation updates automatically when code is shipped?

Documentation updates cannot be triggered automatically when code is shipped. Post-ship synchronization supports only manual triggering via the /document-release command, ensuring you have explicit control over when README and ARCHITECTURE files are aligned.

Why does my post-ship documentation drift out of sync with merged changes?

Post-ship documentation drifts out of sync because reconciling diffs across multiple files is error-prone when done manually. Without enforcing cross-document consistency after a ship, README, CONTRIBUTING, and CLAUDE.md files fail to reflect the exact merged changes.

Do I need any external dependencies to enforce cross-document consistency for my docs?

You do not need any external dependencies to enforce cross-document consistency for your docs. The synchronization and polishing process for README, ARCHITECTURE, and CLAUDE.md works without requiring additional components or libraries.