skills.rest
lachieh
lachiehCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Diff project docs against shipped changes and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Updated Mar 15, 2026
Search Tags:#documentation#diff-analysis#docs-sync#version-bump#change-log#contributor-mode
One-click install
npx skills add https://github.com/lachieh/babytalk --skill document-release-lachieh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/lachieh/babytalk/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/lachieh/babytalk --skill document-release-lachieh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation can drift from reality as code and docs diverge. This Skill automates syncing documentation across key files, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION, ensuring stakeholders always read accurate, aligned docs after a PR is shipped.

Core Features & Use Cases

  • Reads and diffs documentation against the shipped state.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect changes.
  • Polishes CHANGELOG, cleans TODOS, and optionally bumps VERSION after ship.

Quick Start

After a ship or PR merge, run this skill to auto-sync docs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md, polish the CHANGELOG, clean TODOS, and optionally bump VERSION.

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 is merged?▼

Automating documentation updates after a PR merge involves reading project docs, diffing them against shipped changes, and applying updates to README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to ensure accurate alignment.

What is the best way to keep my CHANGELOG and README in sync with shipped code?▼

Keeping CHANGELOG and README in sync with shipped code requires post-ship documentation alignment, which diffs project docs against the shipped state to apply updates, polish CHANGELOG voice, and clean up TODOS.

Can I automatically bump my project VERSION when documentation syncs?▼

Yes, you can optionally bump VERSION after a PR is merged or code is shipped, alongside applying documentation updates and polishing the CHANGELOG to reflect the shipped state.

Do I need specific CLI tools to sync documentation with shipped changes?▼

Syncing documentation with shipped changes requires common CLI tools and access to modify repository files to ensure documentation accuracy across README, ARCHITECTURE, and CONTRIBUTING.

When should I run a documentation diff analysis against my repository?▼

You should run documentation diff analysis after a ship or PR merge to detect divergence between project docs and shipped code, then apply updates to README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Related Skills

Explore More Content & Communication Skills→
louisfghbvclouisfghbvc
4

document-release

Update project documentation to align with shipped code changes.

Community
Advanced
ScivorScivor

document-release

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

Community
Advanced
ClyptAIClyptAI

document-release

Update project documentation and changelog to reflect shipped changes.

Official
Advanced
chriswesttchriswestt

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping changes.

Community
Advanced