document-release

Sync post-ship diffs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Updated Apr 22, 2026

Search Tags:#changelog #documentation #diff #claude.md #docs #post-ship

Ready to run

npx skills add https://github.com/diiviikk5/rezops --skill document-release-diiviikk5

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/diiviikk5/rezops/tree/main/document-release
Command: npx skills add https://github.com/diiviikk5/rezops --skill document-release-diiviikk5

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill reduces manual post-release doc maintenance by automatically syncing shipped changes across key project docs and polishing language.

Core Features & Use Cases

Cross-reference diffs to update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
Polish CHANGELOG language, clean up TODOS, and optionally bump VERSION.
Trigger on demand or proactively after PR merges or code ships.

Quick Start

Run the document-release skill to update project docs after shipping.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I automatically update project documentation after shipping code?▼

To update project documentation after shipping, you can trigger a post-ship sync that cross-references diffs to align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the latest changes.

What is the best way to keep a CHANGELOG and CLAUDE.md synced with recent commits?▼

Keeping a CHANGELOG and CLAUDE.md synced is done by cross-referencing shipped diffs, polishing CHANGELOG language, cleaning up TODOS, and optionally bumping the VERSION across project docs.

Can I automatically clean up TODOS and bump VERSION in my repo after a merge?▼

Yes, you can automatically clean up TODOS and optionally bump VERSION by running a post-ship documentation sync triggered after PR merges or code ships.

Does updating README and ARCHITECTURE docs require manual diff checking?▼

Updating README and ARCHITECTURE docs does not require manual diff checking; the process automatically cross-references shipped changes and syncs the documentation accordingly.

When do I need to sync documentation across multiple project files?▼

You need to sync documentation across multiple project files whenever you ship code, ensuring README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md reflect the latest shipped changes.

What are the limitations of automating post-ship docs updates?▼

Automating post-ship docs updates requires access to the repository's existing documentation files and operates on post-ship contexts, meaning it cannot update docs without prior repo access.