document-release

Parse Git diff outputs to update Markdown documents after releases.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

The document-release skill resolves the problem of post-shipment documentation maintenance by automatically updating all relevant documents with information about the newly shipped changes, facilitating effective team communication and documentation synchronization.

Core Features & Use Cases

  • Automatic Documentation Updates: Automates the process of updating all project documents (e.g., README, Architecture, Contributing, CLAUDE.md) after each shipment, including changelogs, to reflect what was released.
  • Documentation Drift Detection: Detects any changes or discrepancies in architectural diagrams, ensuring the consistency of project documentation.
  • Quality Improvement: Cleans up documentation, such as removing TODOs, improving the readability of changelogs, and ensuring they align with the user experience and business outcomes.
  • Proactive Suggests: Offers proactive updates or reminders to the team to keep the documentation current.

Quick Start

Trigger the document-release skill after each shipment or when explicitly instructed by a team member.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate changelog updates after a shipment?

Automate changelog updates by parsing diff outputs to match released changes and update the corresponding Markdown documents. This ensures changelogs accurately reflect newly shipped changes for effective team coordination.

What is the best way to keep Markdown documentation in sync with Git version control?

Keeping Markdown documentation in sync involves automatically parsing Git diff outputs after shipment to detect discrepancies and update relevant project files. This prevents documentation drift and maintains architectural consistency.

How do I detect documentation drift in project repositories?

Detect documentation drift by parsing diff outputs to identify discrepancies between released code changes and existing Markdown documents. This process flags outdated architectural diagrams and ensures project documentation consistency.

Can I automatically update README and architecture files after a Git release?

Yes, you can automatically update README, Architecture, and Contributing files by parsing diff outputs after each shipment. This matches released changes to the corresponding Markdown documents for post-shipment communication.

Does this documentation automation work with Markdown files and Git version control?

Yes, this documentation automation is designed for project repositories using Markdown files and Git version control. It parses diff outputs to update documents and track changes effectively after shipment.

When should I trigger post-shipment documentation updates?

Trigger post-shipment documentation updates immediately after each shipment or when explicitly instructed by a team member. This ensures all relevant documents, including changelogs, reflect the newly released changes.