document-release

Scans diffs and updates core docs after shipping.

Updated Mar 31, 2026
One-click install
npx skills add https://github.com/benrapport/Vote-Better --skill document-release-benrapport
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/benrapport/Vote-Better/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/benrapport/Vote-Better --skill document-release-benrapport

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update is tedious and error-prone. This skill automates reading repo diffs and updating core docs to reflect what shipped, ensuring the public and internal docs stay aligned.

Core Features & Use Cases

  • Reads diffs and updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG language, cleans up TODOS, and optionally bumps VERSION after a release.
  • Proactively suggest updates after PRs or code shipped, while preserving safety and non-destructive edits.

Quick Start

Run document-release to automatically scan diffs and update core docs.

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 ARCHITECTURE docs after shipping code?

You can automatically update README and ARCHITECTURE docs by scanning repository diffs to align documentation with shipped changes. This process suggests non-destructive edits for review before applying modifications, ensuring documentation stays accurate without manual rewriting.

What is diff analysis for documentation updates?

Diff analysis for documentation updates is the process of reading code changes to synchronize project docs. It identifies modifications in a repository and updates relevant files like CONTRIBUTING.md and CLAUDE.md to reflect the actual shipped state.

Can I automatically bump the VERSION file and polish my CHANGELOG?

Yes, you can automatically bump the VERSION file and polish your CHANGELOG. The process cleans up TODOS, refines CHANGELOG language, and optionally increments the version number if configured, suggesting these changes as safe edits for review.

How do I keep CLAUDE.md and CONTRIBUTING.md aligned with recent code commits?

Keeping CLAUDE.md and CONTRIBUTING.md aligned with recent commits requires proactively scanning diffs after code is shipped. The process reads changes and suggests updates to these core docs to ensure internal and public documentation matches the latest codebase.

Are automated documentation updates safe to run on an existing repository?

Automated documentation updates are safe and non-destructive on existing repositories. The process suggests edits for review before applying any changes, ensuring you maintain full control over what modifications are actually written to your core documentation files.