document-release

Update repository documentation files from git diffs after code merges.

9|1|Updated Apr 16, 2026
One-click install
npx skills add https://github.com/CarbeneAI/Forge --skill document-release-carbeneai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/CarbeneAI/Forge/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/CarbeneAI/Forge --skill document-release-carbeneai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps project documentation accurate after code changes by scanning diffs, applying factual updates, and highlighting or prompting for any risky narrative edits that need human approval. It prevents drift between shipped code and README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, CHANGELOG, and TODOS.

Core Features & Use Cases

  • Diff-aware updates: Reads the branch diff and updates file paths, counts, and factual items across documentation.
  • CHANGELOG voice polish: Polishes wording in CHANGELOG entries without rewriting or deleting recorded history.
  • Guided approvals: Automatically applies clear factual edits and uses AskUserQuestion for version bumps, large narrative changes, or other risky decisions.
  • TODOS and discoverability: Moves completed TODOs when obvious, flags discoverability gaps between README and CLAUDE.md, and ensures cross-doc consistency.
  • Use Case: After merging a feature branch, run the skill to auto-sync README examples, update docs references, polish CHANGELOG bullets, and surface any content that requires your review.

Quick Start

Use the document-release skill to update README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, and TODOS to reflect the changes in this branch and prompt me where human approval is needed.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automatically update README and CHANGELOG after merging a feature branch?

To update README and CHANGELOG after merging, run the document-release skill which reads git diffs and applies factual edits to documentation files automatically. It scans branch changes and updates file paths, counts, and factual items across README, ARCHITECTURE, and CHANGELOG.

What is documentation drift and how do I prevent it after shipping code?

Documentation drift is the gap between shipped code and project docs. You prevent it by running a post-ship sync that reads branch diffs, applies factual updates to README and CHANGELOG, and prompts for risky narrative edits requiring human approval.

Can I automatically polish CHANGELOG entries without rewriting recorded history?

Yes, you can polish CHANGELOG entries without rewriting history by using a guided documentation sync tool. It refines wording in existing entries, preserves the original record, and applies clear factual edits without deleting past content.

Does diff-aware documentation update work for version bumps and large narrative changes?

Diff-aware documentation update does not auto-apply version bumps or large narrative changes. It uses a guided approval system that applies clear factual edits automatically but prompts you for version bumps, narrative changes, and other risky decisions requiring human review.

How do I sync TODOS.md and ensure cross-doc consistency between README and CLAUDE.md?

To sync TODOS.md and ensure cross-doc consistency, run a documentation sync skill that moves completed TODOs when obvious and flags discoverability gaps between README and CLAUDE.md. It scans diffs to resolve inconsistencies across all repository documentation files.

What's the best way to update ARCHITECTURE.md and CONTRIBUTING.md after a release?

The best way to update ARCHITECTURE.md and CONTRIBUTING.md after a release is to use an automated diff analysis tool that reads the branch diff against the base branch and applies factual edits to documentation. This prevents drift between shipped code and project docs.