skills.rest
TimHL5
TimHL5COMMUNITY
Explore all skills by this author →
GitHub

document-release

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

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is a real risk. This Skill automates reading project docs, cross-referencing diffs, and updating key sections to reflect what was shipped, reducing manual drift and copy-paste errors.

Core Features & Use Cases

  • Auto-sync: updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Changelog polish and TODOS cleanup: improves the project docs voice and task tracking.
  • Optional version bump readiness: can bump VERSION when documentation changes justify a new release.

Quick Start

Run the document-release workflow to automatically align docs with the latest ship.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update README and documentation files after a release?▼

To update README and documentation files after a release, you need to cross-reference repo diffs and align the content. This skill automates syncing README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with the latest shipped changes to prevent manual drift.

What is the best way to sync a changelog with recent code changes?▼

The best way to sync a changelog with recent code changes is to cross-reference repository diffs and polish the changelog voice. This skill automates reading project docs and updating key sections to accurately reflect what was shipped.

How does post-ship documentation drift happen and how can I fix it?▼

Post-ship documentation drift happens when project docs fall out of sync with shipped code changes. You can fix it by cross-referencing repo diffs and automatically aligning README, ARCHITECTURE, and CONTRIBUTING files to reflect the latest updates.

Can I automatically bump the VERSION file when documentation changes justify a release?▼

Yes, you can bump the VERSION file when documentation changes justify a new release. This skill includes optional version bump readiness to automatically increment the version alongside post-ship documentation updates.

How do I clean up TODOS and polish project documentation after shipping?▼

To clean up TODOS and polish project documentation after shipping, run a post-ship workflow that cross-references diffs. This skill improves the project docs voice and cleans up task tracking to reduce copy-paste errors.

Does this documentation update tool require any external dependencies or components?▼

No, this documentation update tool does not require any external dependencies or components to function. It operates natively to read project docs, cross-reference diffs, and align key sections without needing additional packages.

Related Skills

Explore More Content & Communication Skills→
Jia-Hong-PengJia-Hong-Peng

document-release

Synchronize project documentation with shipped code changes across multiple document types.

Community
Advanced
axiomanticaxiomantic
8

documentation-updates

Sync CHANGELOG, README, and docs after library changes.

Official
Intermediate
GrassHopper42GrassHopper42

document-release

Automates documentation updates after release using Git diff analysis and Markdown files.

Community
Advanced
esopianesopian
2

document-release

Update project documentation files to reflect shipped code and version changes.

Community
Intermediate