skills.rest
rahmanayon
rahmanayonCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation to reflect shipped changes and polish changelog voice.

Updated Apr 5, 2026
Search Tags:#changelog#architecture#versioning#documentation#readme#diff#post-ship
One-click install
npx skills add https://github.com/rahmanayon/beehive --skill document-release-rahmanayon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/rahmanayon/beehive/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/rahmanayon/beehive --skill document-release-rahmanayon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone. This skill reads shipped changes, cross-references the diff, and updates core project docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect what was shipped, polishes CHANGELOG tone, cleans up TODOS, and can optionally bump the VERSION.

Core Features & Use Cases

  • Cross-reference shipped diffs against documentation to ensure alignment.
  • Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to mirror the shipped changes.
  • Polish CHANGELOG language and tidy TODOS for release readiness.
  • Optionally bump the VERSION and proactively surface alignment suggestions after releases.

Quick Start

After a PR is merged or code is shipped, invoke the document-release workflow to synchronize docs with the latest changes.

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 README and CHANGELOG after shipping code changes?▼

To automatically update README and CHANGELOG after shipping, you can use a post-ship documentation synchronization workflow. It cross-references the shipped diff against project docs and applies updates to match the latest changes.

What is the best way to keep project documentation in sync with shipped code diffs?▼

Keeping project documentation in sync with shipped code diffs involves cross-referencing the diff against core files like README, ARCHITECTURE, and CONTRIBUTING. This process ensures your docs accurately reflect the shipped changes without manual intervention.

How do I polish changelog tone and clean up TODOS for a release?▼

Polishing changelog tone and cleaning up TODOS for a release is done by applying a post-ship documentation update. This process refines the CHANGELOG language and tidies remaining TODOS to ensure release readiness.

Can I automatically bump the VERSION and surface alignment suggestions after a release?▼

Yes, you can automatically bump the VERSION and surface alignment suggestions after a release. This post-ship documentation step optionally updates the version number and proactively suggests areas needing alignment.

Does post-ship documentation update work with CLAUDE.md and ARCHITECTURE files?▼

Yes, post-ship documentation update works with CLAUDE.md and ARCHITECTURE files. The process reads shipped changes and applies updates across these core project documents to ensure they mirror the shipped diff accurately.

Related Skills

Explore More Content & Communication Skills→
mgher668mgher668

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped diffs.

Community
Advanced
typemdtypemd
9

create-release

Gather closed issues and commits to draft release notes and create a GitHub draft release.

Official
Advanced
jayzalowitzjayzalowitz
2

document-release

Update core docs and CHANGELOG after shipping code changes.

Community
Advanced
tony30552001tony30552001

document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped code diffs.

Community
Advanced