document-release

Name: document-release
Availability: InStock
Author: cattboy

Update project documentation to reflect shipped code changes after release.

1|Updated Mar 13, 2026

Search Tags:#changelog #architecture #documentation #readme #docs #version-bump #post-ship

Ready to run

npx skills add https://github.com/cattboy/lil_bro --skill document-release-cattboy

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping, project documentation often drifts out of sync with the actual codebase. document-release automatically updates key docs to reflect shipped changes, reducing confusion and support overhead.

Core Features & Use Cases

Update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect the latest ship diffs.
Polish CHANGELOG language and clean up TODOS to keep the project documentation tidy.
Optionally bump the VERSION to align with the shipped release and tag the release notes.

Quick Start

Run the document-release skill after a PR merge to refresh the project's docs to match the shipped code.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I keep documentation in sync with code changes after a release?▼

To keep documentation in sync after a release, you cross-reference ship diffs against project docs like README.md and ARCHITECTURE.md to automatically apply updates reflecting the latest code changes.

What is the best way to polish changelog language and clean up TODOs post-ship?▼

The best way to polish changelog language and clean up TODOs post-ship is to run an automated documentation pass that refines text and removes completed items directly from your markdown files.

Can I automatically bump the version and update CONTRIBUTING.md after a PR merge?▼

Yes, you can automatically bump the project version and update CONTRIBUTING.md after a PR merge by applying post-release workflows that optionally align the version with the shipped release notes.

Which project documentation files should I update when shipping new code?▼

When shipping new code, you should update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to ensure all tracked project documentation stays in lockstep with the shipped codebase.

Do I need to manually diff code changes to update my project documentation?▼

You do not need to manually diff code changes to update project documentation; automated tools can read project files and cross-reference diffs to perform file updates and keep docs in lockstep.