skills.rest
jayzalowitz
jayzalowitzCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Update core docs and CHANGELOG after shipping code changes.

2|Updated Mar 31, 2026
Search Tags:#versioning#documentation#diff#CHANGELOG#polish#readmes
One-click install
npx skills add https://github.com/jayzalowitz/skytwin --skill document-release-jayzalowitz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/jayzalowitz/skytwin/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/jayzalowitz/skytwin --skill document-release-jayzalowitz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation hygiene by aligning docs with shipped changes, polishing CHANGELOG language, cleaning TODOS, and bumping VERSION when needed.

Core Features & Use Cases

  • Reads all project docs, cross-references the diff, updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match what shipped.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION.
  • Proactively suggests documentation updates after a PR is merged or code is shipped.

Quick Start

Run the document-release skill after a PR ships to automatically sync and polish all project 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 merge?▼

Automate documentation updates by scanning project diffs against shipped changes and syncing core docs like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match the new release.

What is the best way to polish CHANGELOG language before a release?▼

Polish CHANGELOG language by running a post-ship documentation audit that refines the release notes voice and cleans up leftover TODOS across the project.

How do I keep my README and ARCHITECTURE docs in sync with shipped code changes?▼

Keep README and ARCHITECTURE docs in sync by reading the project diff after shipping and automatically editing the specified docs to accurately reflect the newly merged changes.

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

Yes, you can automatically bump the VERSION file by running a post-release documentation governance routine that optionally updates the version alongside cleaning TODOS and refining CHANGELOGs.

What does post-ship documentation hygiene involve for a codebase?▼

Post-ship documentation hygiene involves scanning diffs to update core docs, polishing CHANGELOG language, cleaning up TODOS, and bumping VERSION to accurately reflect shipped changes.

Do I need any specific dependencies to run post-release documentation governance tasks?▼

No specific dependencies are required to run post-release documentation governance tasks, as the skill operates independently to scan diffs and update project documentation.

Related Skills

Explore More Content & Communication Skills→
dogeareddogeared

document-release

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

Community
Intermediate
jonaseck2jonaseck2
2

oss-release

Enforce CHANGELOG.md release-note structure with a 10-block rolling window.

Community
Intermediate
srnicholssrnichols
5

release-notes

Generates release notes from Git history and CHANGELOG files.

Community
Intermediate
balajivisbalajivis
2

document-release

Update project documentation to match shipped software changes and release status.

Community
Advanced