document-release

Synchronize project documentation with shipped code using git diff analysis.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintain up-to-date documentation by aligning all project docs with newly shipped features, catching stale READMEs, architecture notes, and changelog omissions.

Core Features & Use Cases

  • Inventory and identify drift across README.md, ARCHITECTURE.md, CHANGELOG.md, TODOS.md, and docs/
  • Diff analysis to verify feature changes are accurately reflected in docs
  • Update and commit refined documentation to ensure consistency with the codebase

Quick Start

Run document-release after shipping a feature to refresh READMEs, architecture docs, and changelogs so they stay in sync with code.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep README and ARCHITECTURE docs aligned with shipped code changes?

To keep documentation aligned with shipped code, analyze git diffs after releases to identify drift across README.md and ARCHITECTURE.md, then apply targeted updates through a constrained workflow that preserves formatting and links.

How do I update CHANGELOG.md automatically based on git history?

Updating CHANGELOG.md relies on analyzing historical git data and feature diffs after a release. The process inventories committed changes, detects omissions in the changelog, and applies refined text updates to reflect the new version.

Can I synchronize documentation across multiple repositories after a release?

Yes, you can synchronize documentation across repositories after releases. The process inventories docs like TODOS.md and docs/ directories, analyzes diffs for feature changes, and commits updates to ensure consistency with the codebase.

What is the best way to detect stale documentation and changelog omissions?

The best way to detect stale documentation is running a diff analysis against the codebase post-release. This identifies divergences between shipped features and existing READMEs, architecture notes, and changelog omissions.

Does updating docs through diff analysis preserve existing markdown formatting?

Yes, updating docs through diff analysis preserves formatting. The workflow applies documentation updates through a constrained process specifically designed to maintain existing markdown structures, formatting, and links.

Do I need historical git data to synchronize project documentation?

Yes, repository access to historical git data is required. This access allows the inventory and diff analysis processes to verify feature changes and accurately apply documentation updates to reflect the latest shipped code.