document-release

Audit markdown files and update PR metadata for software releases.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill eliminates the manual overhead of keeping project documentation, changelogs, and PR bodies in sync with actual code changes, preventing documentation drift and ensuring your project's public-facing information remains accurate.

Core Features & Use Cases

  • Automated Documentation Audit: Cross-references your diff against README, ARCHITECTURE, and CONTRIBUTING files to identify necessary updates.
  • CHANGELOG Voice Polish: Applies a Diataxis-based rubric to ensure your release notes are user-focused and actionable.
  • PR/MR Synchronization: Automatically updates your pull request body and title to reflect the latest version and documentation changes.

Quick Start

Invoke the document-release skill after merging your code to audit all project documentation and synchronize your release notes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate documentation updates after a software release?

Automate documentation updates by cross-referencing your git diff against README, ARCHITECTURE, and CHANGELOG files to identify and apply necessary text changes. This prevents documentation drift by ensuring public-facing project information matches the latest code modifications.

How do I keep my CHANGELOG user-focused when syncing release notes?

Keep CHANGELOG entries user-focused by applying a Diataxis-based rubric to polish the release notes. This ensures your documentation remains actionable and centered on user needs rather than internal implementation details.

Can I sync PR metadata with documentation changes using gh or glab CLI?

Yes, you can sync PR metadata using gh or glab CLI. The workflow automatically updates your pull request body and title to accurately reflect the latest version and the documentation changes you just merged.

What's the best way to prevent documentation drift in git workflows?

The best way to prevent documentation drift is auditing markdown files after merging code changes. Synchronizing release artifacts and project documentation with the latest updates ensures your repository's public-facing information remains accurate and discoverable.

Do I need standard markdown parsing capabilities to audit project documentation?

Yes, standard markdown parsing capabilities are required to audit project documentation accurately. Combined with git and CLI tools, these capabilities ensure your README and ARCHITECTURE files are correctly analyzed and updated during the release workflow.