skills.rest
binfen1
binfen1COMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project docs and CHANGELOG after PR merges.

Updated Mar 23, 2026
Search Tags:#automation#documentation#readme#release#claude.md#CHANGELOG#docs-sync
One-click install
npx skills add https://github.com/binfen1/my-skills --skill document-release-binfen1
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/binfen1/my-skills/tree/main/claude-code/document-release
Command: npx skills add https://github.com/binfen1/my-skills --skill document-release-binfen1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After a ship, teams need to align docs across READMEs, architecture notes, contributing guidelines, and CLAUDE.md. This Skill automates collecting project docs, cross-referencing diffs, and updating the key files to reflect what shipped, reducing manual toil.

Core Features & Use Cases

  • Reads project docs, cross-references the shipped changes, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match what was released.
  • Polishes the CHANGELOG, cleans up TODOS, and optionally bumps the VERSION.
  • Use Case: After a PR merges, run this Skill to synchronize docs with the shipped state.

Quick Start

Run the document-release workflow after merging a PR to synchronize docs and release notes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate documentation updates after a PR merge?▼

Automate documentation updates after a PR merge by running this Skill to cross-reference shipped diffs and deterministically edit README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to match the latest release state.

What is the best way to sync README and CHANGELOG with shipped code changes?▼

Sync README and CHANGELOG with shipped code changes by cross-referencing project diffs against existing docs, polishing the CHANGELOG entries, and deterministically updating file contents to reflect what was released.

Can I automatically bump the VERSION and clean up TODOs when releasing?▼

Yes, you can automatically bump the VERSION and clean up TODOs during a release. This Skill optionally increments the version file and removes completed TODOs while synchronizing project documentation.

Does this documentation sync tool update CLAUDE.md files automatically?▼

Yes, this documentation sync tool updates CLAUDE.md files automatically. It reads existing project docs, cross-references them with shipped diffs, and edits CLAUDE.md deterministically alongside other key files.

When do I need to run post-ship documentation synchronization?▼

Run post-ship documentation synchronization immediately after a PR merges to ensure README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files accurately reflect the newly shipped changes without manual editing toil.

Related Skills

Explore More Software Engineering Skills→
dogeareddogeared

document-release

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

Community
Intermediate
ThiagoGuislottiThiagoGuislotti
2

docs-release-engineer

Generate repository documentation and release artifacts with semantic versioning and link validation.

Community
Intermediate
dev-eloper1dev-eloper1

cl-reviewer

Review and audit technical proposal documents for consistency and accuracy.

Community
Advanced
zhu637882-stackzhu637882-stack

document-release

Update project docs and changelog to reflect a shipped diff.

Community
Advanced