skills.rest
XinheLIU
XinheLIUCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.

Updated Apr 26, 2026
Search Tags:#automation#documentation#CHANGELOG#docs-sync#version-bump#post-ship
One-click install
npx skills add https://github.com/XinheLIU/human-leverage --skill document-release-xinheliu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/XinheLIU/human-leverage/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/XinheLIU/human-leverage --skill document-release-xinheliu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship docs often drift from what code actually ships. This skill automatically aligns project documentation with the latest changes across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md, polishes changelog commentary, tidies TODOS, and can bump VERSION when appropriate.

Core Features & Use Cases

  • Auto-update shipped-facing docs: README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what was released.
  • Polish CHANGELOG language and tidy TODOS to improve clarity and onboarding.
  • Optional version bump when the changes warrant a new release entry.
  • Prepare and attach a doc-diff preview for PRs, then commit and push changes.

Quick Start

Use the document-release skill to automatically align project documentation with the latest shipped changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-ship documentation updates to sync with shipped changes?▼

Automate post-ship documentation updates by reading project docs, cross-referencing shipped changes across branches and PRs, and updating README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to accurately reflect the release.

What is the best way to keep README and ARCHITECTURE docs aligned with recent code releases?▼

The best way to keep README and ARCHITECTURE docs aligned is using a skill that cross-references shipped changes and automatically updates key project files to reflect what was actually released.

Does this documentation sync tool polish CHANGELOG entries and clean TODOS?▼

Yes, this documentation sync tool polishes CHANGELOG language for clarity, cleans up TODOS to improve onboarding, and optionally bumps the VERSION file when the shipped changes warrant a new release entry.

Can I generate a doc-diff preview for PRs before committing updated documentation?▼

Yes, you can generate a doc-diff preview for PRs. The skill prepares and attaches the preview to pull requests, then commits and pushes the updated documentation changes directly.

When do I need to update CONTRIBUTING.md and CLAUDE.md after a ship?▼

You need to update CONTRIBUTING.md and CLAUDE.md after a ship when your repository requires these files to be synced with recent changes across branches and PRs to prevent documentation drift.

Related Skills

Explore More Content & Communication Skills→
fray-cloudfray-cloud

document-release

Automates updating project docs after inspecting committed code changes.

Community
Advanced
zaeem-rafiqzaeem-rafiq

document-release

Automate post-ship documentation updates across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files.

Community
Advanced
TobiasPerryTobiasPerry

document-release

Read diffs and update core project documentation after shipping.

Community
Advanced
jonkikyjonkiky

document-release

Update project documentation to reflect shipped changes after a merge.

Community
Intermediate