document-release

Update core project documentation to reflect shipped changes on a feature branch.

48|2|Updated Dec 23, 2017
One-click install
npx skills add https://github.com/g4rcez/dotfiles --skill document-release-g4rcez
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/g4rcez/dotfiles/tree/main/.ai/skills/document-release
Command: npx skills add https://github.com/g4rcez/dotfiles --skill document-release-g4rcez

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common; this skill reads shipped diffs and updates core docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect what was released, polishing the CHANGELOG language and tidying TODOS, and optionally bumping VERSION.

Core Features & Use Cases

  • Automatically align documentation with shipped changes across key docs after release.
  • Polish changelog language and ensure consistency with the diff.
  • Optionally bump the VERSION and prepare a clean PR body for review.

Quick Start

Run the document-release skill on your feature branch to update 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 automate documentation updates after a release to prevent docs drift?

Automating documentation updates after a release involves reading shipped diffs and updating core project files like README, ARCHITECTURE, and CONTRIBUTING to reflect the actual changes. This ensures docs stay aligned with the codebase without manual rewriting.

What is the best way to polish a changelog and bump a version number from a feature branch?

Polishing a changelog and bumping a version number from a feature branch requires analyzing the committed diff to refine the release language. The process enforces safe edits on a separate branch and prompts for version decisions before generating a PR body preview.

Can I automatically tidy TODOs and update CLAUDE.md based on shipped code changes?

Yes, you can automatically tidy TODOs and update CLAUDE.md based on shipped code changes by running an automation skill on your feature branch. It reads the release diff to clean up outstanding tasks and synchronize AI context files.

Does automated release management work without external dependencies or components?

Automated release management can function without external dependencies or components by operating natively within your repository. It processes diffs, polishes changelogs, and manages version bumps entirely through internal logic on your feature branch.

When should I not use automated documentation updates for my project?

You should avoid automated documentation updates when your release requires highly nuanced architectural explanations or manual narrative adjustments that exceed the scope of standard diff-based polishing, changelog tidying, and version bumping.

How does post-ship documentation automation handle version bumping decisions?

Post-ship documentation automation handles version bumping by prompting you for version decisions directly when needed. It operates safely on a feature branch, ensuring the version bump is reviewed before producing a concise PR body diff preview.