skills.rest
TioSavich
TioSavichCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, changelog, TODOs, and optionally bump VERSION after shipping code.

Updated Sep 10, 2024
Search Tags:#automation#versioning#documentation#docs#CHANGELOG#diff-analysis#post-ship
One-click install
npx skills add https://github.com/TioSavich/UMEDCTA --skill document-release-tiosavich
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/TioSavich/UMEDCTA/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/TioSavich/UMEDCTA --skill document-release-tiosavich

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common: this skill updates README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG to reflect shipped changes, polishes tone, cleans up TODOS, and can bump VERSION when requested.

Core Features & Use Cases

  • Cross-reference diffs to keep docs aligned with shipped code
  • Update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md to reflect the current state
  • Polish CHANGELOG voice and tidy TODOS; optionally bump VERSION on demand

Quick Start

Run the document-release skill after shipping to align docs with the latest changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update documentation after shipping a PR?▼

To update documentation after shipping, run the skill to analyze your merged code diff and automatically refresh README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG files to match the newly shipped code state.

What is the best way to prevent CHANGELOG drift after a release?▼

Preventing CHANGELOG drift involves cross-referencing shipped code diffs against existing documentation. This skill automatically parses diffs to align post-ship docs and polish the changelog voice.

Can I automatically bump VERSION and clean up TODOS when code is merged?▼

Yes, you can automatically tidy TODOS and optionally bump VERSION. Trigger this skill post-merge to parse file frontmatter and apply targeted edits across your documentation.

Does this documentation alignment tool require external dependencies?▼

No external dependencies are required. The documentation alignment process relies entirely on a Bash-based workflow using allowed tools to parse diffs and edit files.

When should I run post-ship documentation updates?▼

Run post-ship documentation updates immediately after PRs are merged or code is shipped. This ensures your README, ARCHITECTURE, and CLAUDE.md files accurately reflect the current application state.

Related Skills

Explore More Content & Communication Skills→
ClyptAIClyptAI

document-release

Update project documentation and changelog to reflect shipped changes.

Official
Advanced
cowwoccowwoc
101

Release Claude Code Plugin

Orchestrate Claude Code plugin releases by synchronizing changelogs, version files, and git tags.

Community
Advanced
warpdotdevwarpdotdev
292

implement-specs

Plan and execute feature implementations while keeping specs aligned with code changes.

Official
Advanced
DaviRain-SuDaviRain-Su

document-release

Update project documentation after code shipment using Git diff analysis.

Community
Advanced