skills.rest
rshelekhov
rshelekhovCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Automate post-ship documentation updates across project files.

Updated Nov 11, 2025
Search Tags:#changelog#documentation#review#polish#diff-analysis#version-bump#docs-update
One-click install
npx skills add https://github.com/rshelekhov/dotfiles --skill document-release-rshelekhov
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/rshelekhov/dotfiles/tree/main/claude/skills/gstack/document-release
Command: npx skills add https://github.com/rshelekhov/dotfiles --skill document-release-rshelekhov

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates across a project, ensuring all public docs reflect shipped changes.

Core Features & Use Cases

  • Cross-checks README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped
  • Polish CHANGELOG language and clean up TODOS
  • Optionally bump the VERSION when changes warrant a release

Quick Start

Run the document-release skill on the current branch to synchronize project docs 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 documentation updates after shipping a release?▼

Automate post-ship documentation updates by diffing shipped changes and modifying README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to accurately reflect the new release state.

What is the best way to keep a project changelog and version number current?▼

Keep changelogs and version numbers current by analyzing branch diffs, polishing CHANGELOG language, cleaning up TODOS, and optionally bumping the VERSION file when changes warrant a release.

Can I sync multiple project documents like README and CONTRIBUTING at the same time?▼

Yes, you can sync multiple project documents simultaneously. The workflow cross-checks README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md together to ensure all public docs reflect shipped changes.

How do I clean up TODOS and polish changelog language before a release?▼

Clean up TODOS and polish changelog language by running a diff analysis on the current branch, which identifies completed work to update documentation and refine CHANGELOG wording automatically.

Do I need to manually check the diff before bumping the VERSION file?▼

No, you do not need to manually check the diff. The workflow analyzes the diff automatically and optionally bumps the VERSION file when the shipped changes warrant a release.

Related Skills

Explore More Content & Communication Skills→
robzolkosrobzolkos
3

catchup

Compare the working branch with master and read modified specs.

Community
Basic
PiercingXXPiercingXX
1

release-doc-sync

Synchronize post-release documentation with shipped changes and generate a sync report.

Community
Intermediate
Rune-kitRune-kit
82

git

Generate semantic commit messages and Pull Request descriptions from Git history.

Official
Advanced
bettercallzaalbettercallzaal
1

fishbowlz

Sync ZAO OS changes to GitHub and deploy to fishbowlz.com.

Community
Intermediate