skills.rest
curielmc
curielmcCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Align project documentation with shipped changes after merges.

Updated Feb 27, 2026
Search Tags:#automation#changelog#versioning#documentation#diff#docs-sync#post-ship
One-click install
npx skills add https://github.com/curielmc/beat-SPY --skill document-release-curielmc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/curielmc/beat-SPY/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/curielmc/beat-SPY --skill document-release-curielmc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation maintenance by aligning docs with what shipped—ensuring README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md reflect the latest changes, polishing the CHANGELOG voice, cleaning up TODOS, and optionally bumping VERSION after merges.

Core Features & Use Cases

  • Automated cross-file doc syncing: Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped.
  • Changelog tone polishing and TODOS clean-up: Improve language and tidy tasks; optionally bump VERSION after ship.
  • Proactive documentation drift detection: Suggest updates after PR merges or code shipments to keep docs current.

Quick Start

Run the document-release workflow after a ship or when you want docs synced with 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 keep documentation in sync with shipped code changes automatically?▼

To automate changelog updates after a merge, you can polish changelog wording, clean up TODOS, and optionally bump the VERSION file. This workflow preserves CHANGELOG integrity while reflecting shipped changes accurately.

What is the best way to update cross-file references in project docs after a release?▼

The best way to update cross-file references in project docs is by running an automated post-ship workflow. It detects changes via diffs and updates multiple files like README, CLAUDE.md, and ARCHITECTURE to reflect what shipped.

Can I detect documentation drift proactively after merging a PR?▼

Yes, you can detect documentation drift proactively after merging a PR or shipping code. The workflow suggests updates to keep docs current by aligning them with the shipped changes and cleaning up outdated TODOS.

Does this documentation sync workflow require any external dependencies?▼

No, this documentation sync workflow has zero external dependencies. It relies on standard Bash, Read, Write, and Edit tools to perform deterministic file edits and detect changes using diffs.

When should I not use automated post-ship documentation maintenance?▼

You should not use automated post-ship documentation maintenance for projects lacking multiple docs like README, ARCHITECTURE, or CLAUDE.md. It is designed specifically to align docs with shipped code and preserve CHANGELOG integrity.

Related Skills

Explore More Content & Communication Skills→
AlexandreLabAlexandreLab

gstack-document-release

Update repository documentation files after merged code changes.

Community
Advanced
marcel-heinzmarcel-heinz
4

release

Coordinate ClawCity release workflows with version bumps, changelog updates, git tagging, and GitHub releases.

Community
Advanced
dr-codedr-code

release-check

Run pre-release verification checks and write a versioned release assessment report.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate