document-release

Audit documentation diffs between base and HEAD after a ship.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After every ship, documentation often drifts from code changes, creating confusion and maintenance overhead.

Core Features & Use Cases

  • Diff-driven audit: compares base vs HEAD to identify outdated or missing docs.
  • Auto-update & consistency: applies straightforward corrections and aligns CHANGELOG, READMEs, and docs reference files.
  • Governance workflow: prompts for risky narrative edits and prepares a PR-ready documentation summary.

Quick Start

Trigger the document-release workflow after ship to align docs with the latest changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep documentation in sync after a release?

To keep documentation in sync after a release, you can trigger a post-ship workflow that analyzes code diffs between base and HEAD to identify outdated documentation drift and apply automatic updates.

What is documentation drift and how do I detect it?

Documentation drift occurs when docs become outdated after code changes. You detect it by running a diff-driven audit that compares your base branch against HEAD to identify missing or outdated references.

Can I automatically update CHANGELOG and README files after a ship?

Yes, the workflow automatically aligns CHANGELOG, READMEs, and reference files by applying straightforward corrections identified during the diff analysis, ensuring cross-doc consistency.

How do I prepare a PR body summary for documentation updates?

You prepare a PR-ready documentation summary by auditing files, formatting changes, and generating a governance summary that highlights applied corrections and risky narrative edits requiring review.

When should I manually review risky narrative edits in docs?

You should manually review risky narrative edits when the governance workflow detects potentially impactful changes to documentation context, prompting you to verify updates before finalizing the PR.