document-release

Cross-reference shipped diffs and update project documentation files.

Updated Aug 2, 2025
One-click install
npx skills add https://github.com/JovieInc/Jovie --skill document-release-jovieinc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/JovieInc/Jovie/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/JovieInc/Jovie --skill document-release-jovieinc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are automated by cross-referencing shipped diffs and aligning project docs.

Core Features & Use Cases

  • Reads the project documentation and the diff to identify changes shipped with the release.
  • Updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION to reflect new work.

Quick Start

Trigger the document-release workflow on the PR you want to update, then review the proposed changes.

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 from a PR diff?

Automate post-ship documentation updates by cross-referencing the PR diff to synchronize shipped changes. It reads the diff to identify modifications and aligns project docs accordingly.

Does this documentation tool update README and ARCHITECTURE files automatically?

Yes, this documentation tool automatically updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md. It cross-references shipped diffs to ensure these files accurately reflect the new release changes.

What is the best way to polish a CHANGELOG and clean up TODOS after a release?

The best way to polish a CHANGELOG and clean up TODOS is using an automated release workflow that cross-references shipped diffs. It refines the changelog voice and organizes TODOS while optionally bumping the VERSION.

How does diff-analysis keep project documentation accurate after shipping code?

Diff-analysis keeps project documentation accurate by cross-referencing shipped code changes against existing docs. It enforces structured audits and risk checks to maintain cohesive documentation across the project.

Can I trigger documentation synchronization within my existing release workflows?

Yes, you can trigger documentation synchronization within your existing release workflows. It applies directly to PRs to propose documentation updates, which you can then review before merging.

Are there limitations to automating version bumps and doc updates for unmerged branches?

A limitation of automating version bumps and doc updates is that it targets merged PRs and shipped releases. Unmerged branches lack the finalized diff required to accurately audit and synchronize documentation.