skills.rest
alexandervashurin
alexandervashurinCOMMUNITY
Explore all skills by this author →
GitHub

document-release

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

1|Updated Feb 25, 2026
Search Tags:#automation#versioning#documentation#CHANGELOG#docs-sync#post-ship
One-click install
npx skills add https://github.com/alexandervashurin/semaphore --skill document-release-alexandervashurin
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/alexandervashurin/semaphore/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/alexandervashurin/semaphore --skill document-release-alexandervashurin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update is tedious and error-prone. This Skill automates aligning core docs with the latest shipped changes, reducing manual drift and ensuring consistency across release notes and contributor guidance.

Core Features & Use Cases

  • Reads project docs and diffs them against the shipped state to identify changes.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the latest release.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION metadata.
  • Proactively suggests documentation updates after a PR is merged or code is shipped.

Quick Start

Run the document-release workflow after shipping to synchronize your documentation 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 automate documentation updates after a release?▼

Automating documentation updates after a release involves computing diffs between current and shipped states to align README, ARCHITECTURE, and CONTRIBUTING files with the latest changes. This process reduces manual drift by proactively suggesting text revisions post-ship.

What is the best way to keep a CHANGELOG synced with merged PRs?▼

Keeping a CHANGELOG synced with merged PRs requires reading project diffs and polishing the changelog voice to reflect the latest release. This ensures consistency across release notes and contributor guidance without manual entry errors.

How do I update README and ARCHITECTURE files after shipping code?▼

Updating README and ARCHITECTURE files after shipping code requires diffing the current repository state against the shipped version. This identifies necessary changes to align core documentation with the latest release, preventing post-ship documentation drift.

Can I automatically bump version metadata in my docs when a PR merges?▼

Automatically bumping version metadata when a PR merges is possible by applying optional version bumps during post-ship documentation updates. This requires access to repository docs and the capability to modify version metadata alongside changelog polishing.

What is post-ship documentation drift?▼

Post-ship documentation drift occurs when core project files like README and CONTRIBUTING become misaligned with the latest shipped code. It happens when manual updates are skipped after PR merges, leading to inconsistent release notes and contributor guidance.

Related Skills

Explore More Content & Communication Skills→
fray-cloudfray-cloud

document-release

Automates updating project docs after inspecting committed code changes.

Community
Advanced
jonaseck2jonaseck2
2

oss-release

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

Community
Intermediate
legotec73legotec73

document-release

Update project docs from diffs after code shipment.

Community
Intermediate
mgher668mgher668

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped diffs.

Community
Advanced