skills.rest
nocnocgroup
nocnocgroupOFFICIAL
Explore all skills by this author →
WebsiteGitHub

document-release

Cross-reference diffs and update shipped documentation files after merges.

Updated Mar 21, 2026
Search Tags:#changelog#versioning#documentation#docs#diff-analysis#post-ship
One-click install
npx skills add https://github.com/nocnocgroup/gstack --skill document-release-nocnocgroup
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/nocnocgroup/gstack/tree/main/document-release
Command: npx skills add https://github.com/nocnocgroup/gstack --skill document-release-nocnocgroup

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often diverges from what was actually shipped. This Skill automatically audits project docs after changes, cross-references the diff, and applies updates to README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect the shipped state, while polishing CHANGELOG language, tidying TODOS, and optionally bumping VERSION when appropriate.

Core Features & Use Cases

  • Cross-reference diffs after merges to ensure docs match shipped code.
  • Update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect the latest state.
  • Polish CHANGELOG entries for clarity and consistency; tidy TODOS.
  • Optional: bump VERSION to capture new changes in a release.
  • Use after PRs are merged or code is shipped to keep docs in sync.

Quick Start

Run the document-release skill after a PR is merged to synchronize and polish the repo's docs.

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

Sync documentation with shipped code by cross-referencing the diff after a merge to update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect the latest project state.

What is the best way to keep a CHANGELOG and TODOS consistent with shipped code?▼

Keep a CHANGELOG and TODOS consistent by cross-referencing post-ship diffs to polish changelog entries for clarity, tidy TODOS, and optionally bump the VERSION to capture new changes in a release.

Can I automatically bump the VERSION file when shipping new changes?▼

You can automatically bump the VERSION when shipping new changes by running the document-release skill, which optionally captures new changes in a release while polishing documentation.

When do I need to cross-reference diffs for post-ship documentation?▼

You need to cross-reference diffs for post-ship documentation when project docs diverge from what was actually shipped after merging code, ensuring README.md and ARCHITECTURE.md reflect the latest state.

Does this documentation update approach work with CLAUDE.md files?▼

This documentation update approach works with CLAUDE.md files by automatically auditing and applying updates to reflect the shipped state alongside README.md, ARCHITECTURE.md, and CONTRIBUTING.md.

Related Skills

Explore More Content & Communication Skills→
legotec73legotec73

document-release

Update project docs from diffs after code shipment.

Community
Intermediate
danielterradanielterra
19

release-create

Bump versions, update changelogs, and publish GitHub releases.

Community
Advanced
jpcaparasjpcaparas
37

quality-gate

Automate code review checks on a repository before release.

Community
Intermediate
lushly-devlushly-dev
4

do-documentation-update

Update CHANGELOG, AGENTS.md, README.md, and skill files with validation.

Official
Intermediate