skills.rest
pcaokhai
pcaokhaiCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Reconcile project documentation with shipped state by scanning diffs.

Updated Mar 24, 2026
Search Tags:#workflow#documentation#docs#change-log#diff-detection#post-ship
One-click install
npx skills add https://github.com/pcaokhai/gradion-response-report-api --skill document-release-pcaokhai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/pcaokhai/gradion-response-report-api/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/pcaokhai/gradion-response-report-api --skill document-release-pcaokhai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are needed to keep READMEs, architecture notes, contribution guidelines, and CLAUDE instructions aligned with what was shipped. This skill reads all project docs, cross-references the diff, updates the relevant files to match shipped state, polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when you are asked to "update the docs", "sync documentation", or "post-ship docs". Proactively suggest updates after a PR is merged or code is shipped.

Core Features & Use Cases

  • Cross-checks documentation against the actual shipped changes to ensure consistency across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md.
  • Polishes CHANGELOG and TODOS to reflect the latest release, without overwriting existing history.
  • Optional version bump and PR body enrichment to surface documentation changes in the release process.

Quick Start

Execute the document-release workflow after a PR merge to align shipped docs with what was delivered.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I sync documentation with shipped code changes after a release?▼

Post-ship documentation reconciliation scans code diffs to align READMEs, ARCHITECTURE, and CONTRIBUTING files with the actual shipped state. This ensures released documentation accurately reflects what was delivered.

What is post-ship documentation reconciliation?▼

Post-ship documentation reconciliation is the process of cross-referencing project diffs against existing docs to enforce consistency. It aligns README, ARCHITECTURE, and CLAUDE.md files to match the shipped release.

How do I update CHANGELOG and bump VERSION automatically after shipping?▼

You can update CHANGELOG and bump VERSION by running an automated documentation workflow that polishes the changelog voice and applies version bumps when shipped changes warrant them, without overwriting existing history.

Does this documentation sync workflow update CLAUDE.md files?▼

Yes, the documentation sync workflow cross-checks and updates CLAUDE.md files alongside READMEs, ARCHITECTURE, and CONTRIBUTING docs to ensure all project instructions match the delivered shipped state.

When should I run a post-ship docs update?▼

You should run a post-ship docs update after a PR merge to align shipped docs with what was delivered, or proactively whenever you are asked to sync documentation following a code release.

Related Skills

Explore More Content & Communication Skills→
forbotsakeforbotsake
5

document-release

Synchronize post-release documentation with code changes after a PR merge.

Official
Advanced
typemdtypemd
9

create-release

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

Official
Advanced
try-workstry-works
95

conventions-check

Validate pull request titles, descriptions, and scope against repository conventions.

Community
Basic
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic