document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md from code diffs.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/BrandonLee28/brandon-brain --skill document-release-brandonlee28
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/BrandonLee28/brandon-brain/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/BrandonLee28/brandon-brain --skill document-release-brandonlee28

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires Bash, Read, Write, Edit, Grep, Glob, AskUserQuestion, and includes scripts (resource) and references (resource) components.

What problem does it solve?

The document-release Skill automates the post-ship documentation update process, ensuring your project's documentation reflects the latest shipped code and changes.

Core Features & Use Cases

  • Automated Documentation Update: Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match the shipped code.
  • Change Tracking: Cross-references the diff to update documentation accurately.
  • Voice Polishing: Refines the CHANGELOG with a polished voice and removes TODOs.
  • Version Bumping: Optionally bumps the VERSION file.
  • Use Case: After merging a pull request or shipping code, use this Skill to update the documentation with a single command, ensuring consistency and accuracy.

Quick Start

Run the 'document-release' command to update your project's documentation post-ship.

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 project documentation after shipping code changes?

Automating documentation updates post-ship requires cross-referencing code diffs to modify project files. This skill updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to reflect the latest shipped code changes using a single command.

What is the best way to sync a README and CHANGELOG with a recent git diff?

Syncing a README and CHANGELOG with a recent git diff involves analyzing the code changes and applying them to documentation. This skill cross-references diffs to refine the CHANGELOG, remove TODOs, and update README content automatically.

How do I bump a VERSION file and update architecture docs at the same time?

Bumping a VERSION file while updating architecture docs is supported by this skill through an optional version bumping feature. It simultaneously updates ARCHITECTURE documentation based on the shipped code diff to ensure version and structural consistency.

Do I need Bash and Glob tools to automate post-ship documentation updates?

Yes, you need Bash, Glob, Grep, Read, Write, Edit, and AskUserQuestion tools to automate post-ship documentation updates. These dependencies enable the skill to execute scripts, locate files, parse diffs, and apply edits across your project.

Can I update a CLAUDE.md file based on code diffs after a pull request merge?

Yes, you can update a CLAUDE.md file based on code diffs after a pull request merge. The skill specifically targets CLAUDE.md alongside README and CONTRIBUTING files to ensure all project documentation matches the newly merged code.

What are the limitations of automating documentation updates with code diffs?

Limitations of automating documentation updates with code diffs include dependency on specific tools like Bash, Read, Write, and Grep. The skill focuses on README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md, meaning custom documentation files outside this set require manual updates.