document-release

Update project documentation files from branch diffs after PR merges.

46|13|Updated Jul 30, 2025
One-click install
npx skills add https://github.com/aimasteracc/tree-sitter-analyzer --skill document-release-aimasteracc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/aimasteracc/tree-sitter-analyzer/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/aimasteracc/tree-sitter-analyzer --skill document-release-aimasteracc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates read project docs, cross-reference the diff, and update shipped files to reflect the latest state, while polishing CHANGELOG and TODOS.

Core Features & Use Cases

  • Synchronizes README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes after PR merges.
  • Polishes CHANGELOG and TODOS, and can optionally bump VERSION to reflect the release in the log.
  • Supports on-demand runs or proactive post-ship documentation maintenance.

Quick Start

Update docs by requesting a post-ship doc-sync pass for the latest shipped state.

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 documentation after a PR merge?

To update documentation after a PR merge, this Skill reads the target branch diff and syncs README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes automatically or on-demand.

What is the best way to keep a CHANGELOG and VERSION file synced with git diffs?

Keeping a CHANGELOG and VERSION file synced with git diffs involves reading the latest shipped changes and polishing the logs. This Skill reads branch diffs, polishes CHANGELOG and TODOS, and optionally bumps the VERSION file.

Does this documentation updater work without external dependencies?

Yes, this documentation updater works without external dependencies, requiring no listed components or libraries to synchronize README, ARCHITECTURE, and CONTRIBUTING files with your shipped changes.

Can I manually trigger post-ship documentation maintenance instead of running it automatically?

Yes, you can manually trigger post-ship documentation maintenance. This Skill supports on-demand runs, allowing you to request a doc-sync pass for the latest shipped state instead of relying solely on automatic execution.

How does automatic changelog polishing handle user input during versioning?

During automatic changelog polishing and versioning, the Skill provides logging and prompts when user input is required, ensuring the CHANGELOG and TODOS accurately capture the release details from the diff.

When should I avoid automatic post-ship documentation updates?

You should avoid automatic post-ship documentation updates if your workflow lacks a clear target branch diff to read, as the Skill relies on parsing those diffs to update README, ARCHITECTURE, and CONTRIBUTING files.