document-release

Align project documentation with shipped changes after merges.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what shipped. This Skill automates alignment by reading project docs, cross-referencing the diff, and updating key files to reflect the shipped state.

Core Features & Use Cases

  • Cross-doc consistency: updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect shipped changes.
  • CHANGELOG voice polishing and TODOS cleanup to reflect the latest release.
  • Optional: bump the VERSION when appropriate and ensure diffs stay synchronized across docs.

Quick Start

Run this skill after a ship to automatically align and polish documentation across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-ship documentation updates to match shipped changes?

Automate post-ship documentation updates by scanning project docs and cross-referencing diffs to ensure alignment with shipped changes. This skill automatically updates README, ARCHITECTURE, CONTRIBUTING, and CLAude.md files to reflect the latest release state.

Can I automatically bump the VERSION and polish the CHANGELOG after a merge?

Yes, you can bump the VERSION and polish the CHANGELOG after merges. The skill cleans up TODOS, refines the changelog voice, and optionally updates the version number to ensure diffs stay synchronized across all project documentation.

What is the best way to keep markdown docs synchronized with code diffs across a project?

The best way to keep markdown docs synchronized is using diff detection to cross-reference shipped changes against existing documentation. This skill automatically edits markdown frontmatter and sections across README, ARCHITECTURE, and CONTRIBUTING files.

Do I need specific tools or dependencies to automate markdown documentation alignment?

No external dependencies are required, but you need local repo file access. The skill can be configured via allowed-tools like Bash, Read, Write, Edit, Grep, Glob, and AskUserQuestion to perform automated markdown edits and diff scanning.

How does diff detection work for updating project documentation after a release?

Diff detection works by scanning project docs and cross-referencing the code diff to identify drift. It then applies automated edits to markdown sections and frontmatter, ensuring the README, ARCHITECTURE, and CONTRIBUTING files accurately reflect the shipped state.