document-release

Name: document-release
Availability: InStock
Author: Wilder1222

Cross-reference git diffs and update project documentation after releases.

2|Updated Mar 25, 2026

Search Tags:#changelog #architecture #documentation #readme #diff #contributing #post-ship

Ready to run

npx skills add https://github.com/Wilder1222/superomni --skill document-release-wilder1222

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is a common issue; this skill cross-references the actual shipped changes and updates core docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect reality, polish the CHANGELOG voice, and tidy TODOs, with an optional version bump.

Core Features & Use Cases

Cross-reference shipped diffs and align documentation across project files.
Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped state.
Polish CHANGELOG language, clean up stale TODOs, and optionally bump the VERSION after a release.

Quick Start

Run document-release to synchronize all docs with the latest shipped changes after a merge.

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 a merge?▼

Automate post-ship documentation updates by cross-referencing shipped git diffs against project files. This process aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to accurately reflect the latest merged changes.

What is the best way to keep a CHANGELOG and README aligned with actual shipped changes?▼

Keeping a CHANGELOG and README aligned with shipped changes requires cross-referencing git diff outputs. This approach polish CHANGELOG language and updates core project documentation to match the shipped state.

How do I clean up stale TODOs and bump project versions after a release?▼

Clean up stale TODOs and bump project versions by running a post-release synchronization process. This cross-references shipped diffs to tidy TODOs, polish the CHANGELOG, and optionally apply a version bump.

Can I update CLAUDE.md and CONTRIBUTING files automatically based on git diffs?▼

Yes, updating CLAUDE.md and CONTRIBUTING files automatically based on git diffs is possible. The process uses Bash, Read, Write, Edit, Grep, and Glob tools to cross-reference changes and apply documentation updates.

What should I do when my project documentation drifts after shipping new code?▼

To fix post-ship documentation drift, cross-reference the actual shipped diffs against project docs. This updates README, ARCHITECTURE, and CONTRIBUTING files to reflect reality and cleans up stale TODOs.

Does this documentation alignment approach require any external dependencies?▼

No external dependencies are required for this documentation alignment approach. It relies solely on standard git diff output and access to docs files, using built-in tools like Bash, Read, Write, Edit, Grep, and Glob.