skills.rest
bizzybae
bizzybaeCOMMUNITY
Explore all skills by this author →
𝕏@BizzyBaeGitHub

document-release

Reconcile project documentation with shipped code by diffing changes and updating core docs.

Updated Apr 5, 2026
Search Tags:#documentation#readme#diff#CLAUDE.md#CHANGELOG#post-ship
One-click install
npx skills add https://github.com/bizzybae/qstack --skill document-release-bizzybae
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/bizzybae/qstack/tree/main/gstack-original/document-release
Command: npx skills add https://github.com/bizzybae/qstack --skill document-release-bizzybae

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After a release, documentation often drifts from shipped code. This skill aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with what was actually shipped, polishing the CHANGELOG and TODOS, and optionally bumping the version.

Core Features & Use Cases

  • Reads diffs between base and current HEAD to identify impacted docs and sections.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes, with a consistent voice.
  • Polishes CHANGELOG entries and TODOS; can bump VERSION when appropriate.

Quick Start

Run after a release to sync docs with what shipped.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep my README and ARCHITECTURE docs in sync after merging a PR?▼

To keep README and ARCHITECTURE docs in sync after a PR merge, you can use an automated post-ship documentation tool that reads code diffs and applies corresponding updates to your core documentation files while preserving existing voice.

What is the best way to automatically update CLAUDE.md and CONTRIBUTING files after a release?▼

The best way to automatically update CLAUDE.md and CONTRIBUTING files after a release is by diffing the shipped changes against the base HEAD, which identifies impacted sections and applies necessary text revisions across all project documentation for consistency.

Can I automatically polish my CHANGELOG entries and tidy TODOS based on shipped code diffs?▼

Yes, you can polish CHANGELOG entries and tidy TODOS based on shipped code diffs by running a post-ship documentation sync process that reads the changes and refines the text to match the actual project updates and version state.

Does post-ship documentation sync work without external dependencies?▼

Yes, post-ship documentation sync can work without external dependencies, as the process relies entirely on reading internal git diffs and applying text updates directly to existing project files like README and CLAUDE.md without requiring additional packages.

When should I run a documentation reconciliation process after shipping code?▼

You should run a documentation reconciliation process immediately after a release or PR merge to prevent documentation drift, ensuring your README, ARCHITECTURE, and CONTRIBUTING files accurately reflect the newly shipped code changes.

Related Skills

Explore More Content & Communication Skills→
erclxerclx
2

docs-sync

Synchronize README and markdown documentation by rewriting stale sections from git diffs.

Community
Intermediate
ScivorScivor

document-release

Update and reconcile project documentation by cross-referencing diffs after a ship.

Community
Advanced
npc-chrisnpc-chris
1

document-release

Update README, Architecture, Contributing, and Claude.md files after codebase changes.

Community
Advanced
ajsai47ajsai47
11

document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

Community
Advanced