document-release

Update and reconcile project documentation by cross-referencing diffs after a ship.

Updated Apr 11, 2026
One-click install
npx skills add https://github.com/Scivor/helm --skill document-release-scivor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Scivor/helm/tree/main/skills/gstack/document-release
Command: npx skills add https://github.com/Scivor/helm --skill document-release-scivor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone. This Skill reads project docs, cross-references the shipped changes, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what was shipped, while polishing the CHANGELOG and cleaning up TODOS.

Core Features & Use Cases

  • Cross-reference diffs and align documentation with shipped changes.
  • Polish project documentation and changelog voice after a PR is merged or code is shipped.
  • Proactively suggest and apply documentation updates when asked to "update the docs" or "post-ship docs".

Quick Start

Run document-release to update the docs after a 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 documentation after a release?

To automatically update documentation after a release, run a process that cross-references code diffs and applies changes to README, ARCHITECTURE, and CONTRIBUTING files. This ensures your project docs accurately reflect shipped changes.

What is the best way to polish a changelog and clean up TODOS after shipping?

The best way to polish a changelog and clean up TODOS is to use a post-ship documentation tool that parses markdown files and refines the changelog voice. It reconciles shipped changes and removes completed TODOS automatically.

How does cross-referencing diffs improve post-ship documentation?

Cross-referencing diffs improves post-ship documentation by identifying exactly what changed in the codebase and mapping those changes to relevant sections in README, ARCHITECTURE, and CLAUDE.md files. This keeps documentation aligned with actual functionality.

Can I automatically bump the VERSION file when shipped changes warrant it?

Yes, you can automatically bump the VERSION file when shipped changes warrant it. The post-ship documentation update process evaluates the merged code and applies a version bump alongside reconciling your README and CHANGELOG.

Do I need repository access to sync markdown documentation?

Yes, you need repository access to sync markdown documentation. The process requires reading project files, parsing markdown, and writing updates back to critical files like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.