skills.rest
deveshkumars
deveshkumarsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Align repository docs with released changes and polish the CHANGELOG.

Updated Mar 28, 2026
Search Tags:#automation#documentation#diff#docs#CHANGELOG#post-ship
One-click install
npx skills add https://github.com/deveshkumars/Intentra --skill document-release-deveshkumars
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/deveshkumars/Intentra/tree/main/document-release
Command: npx skills add https://github.com/deveshkumars/Intentra --skill document-release-deveshkumars

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is real. This skill keeps repo docs in sync with released changes by scanning the codebase for diffs and applying updates to key docs (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md). It also polishes language in the CHANGELOG and cleans up TODOS, and can optionally bump the VERSION after a release.

Core Features & Use Cases

  • Automated post-ship doc reconciliation: updates core docs to reflect shipped changes across the repository.
  • CHANGELOG polishing and TODOS cleanup: improves tone and removes stale items.
  • Optional version bump: increments VERSION after a release when requested.
  • Triggered post-ship: designed to run after PRs are merged or a release is cut.

Quick Start

Run the document-release skill after shipping to automatically update README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and the CHANGELOG to reflect the 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 post-ship documentation updates across my repository?▼

Automate post-ship documentation updates by scanning the codebase diff and applying edits to core docs like README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect released changes. This keeps repository documentation perfectly in sync after shipping.

What is the best way to keep README and CHANGELOG aligned after a release?▼

Keeping README and CHANGELOG aligned after a release is done by scanning shipped diffs and polishing the CHANGELOG language while updating core documentation like README.md and ARCHITECTURE.md to match the new codebase state.

How do I clean up stale TODOS and polish CHANGELOG entries after merging a PR?▼

Clean up stale TODOS and polish CHANGELOG entries by running a deterministic post-ship workflow that scans the repository diff, improves the CHANGELOG tone, and removes outdated TODO items to reflect the current release state.

Can I automatically bump the VERSION file when updating post-ship documentation?▼

You can automatically bump the VERSION file when updating post-ship documentation by enabling the optional version increment feature, which increments the version number after a release is cut and changes are reconciled.

Does the post-ship documentation workflow require any external dependencies or components?▼

The post-ship documentation workflow requires no external dependencies or components to run. It uses standard tooling to apply edits deterministically, making it easy to trigger after PRs are merged or a release is cut.

When should I run a repository documentation reconciliation process?▼

You should run a repository documentation reconciliation process immediately after a release is cut or PRs are merged. This prevents documentation drift by ensuring README.md, ARCHITECTURE.md, and CHANGELOG reflect the latest shipped codebase changes.

Related Skills

Explore More Content & Communication Skills→
txema-puchtxema-puch
1

document-release

Scan git diffs and update core project documentation after releases.

Community
Advanced
scanbottscanbott

ship

Automate release workflows by merging branches, running tests, bumping versions, and creating PRs.

Community
Advanced
yckkkkyckkkk
1

document-release

Update project documentation files to reflect shipped code changes.

Community
Advanced
dt418dt418

Docs Pack

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

Community
Intermediate