document-release

Name: document-release
Availability: InStock
Author: KrismithReddy12

Audit markdown documentation against git diffs and update changelogs.

Updated Jul 29, 2026

Search Tags:#automation #git #changelog #documentation #release #sync

Ready to run

npx skills add https://github.com/KrismithReddy12/gstack --skill document-release-krismithreddy12

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/KrismithReddy12/gstack/tree/main/document-release
Command: npx skills add https://github.com/KrismithReddy12/gstack --skill document-release-krismithreddy12

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 versioning in sync with actual code changes after a release.

Core Features & Use Cases

Documentation Audit: Automatically cross-references code diffs against README, ARCHITECTURE, and CONTRIBUTING files to identify stale information.
Changelog Polish: Applies a Diataxis-based rubric to ensure changelog entries are user-focused and actionable.
Consistency Check: Ensures all documentation is discoverable and cross-linked, while managing version bumps and PR body updates.

Quick Start

Invoke the document-release skill to audit and update all project documentation to match the latest shipped 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 syncing documentation with git changes after a release?▼

Automating documentation sync verifies markdown files against git diffs to detect stale information. This Skill cross-references README, ARCHITECTURE, and CONTRIBUTING files with codebase changes to ensure documentation consistency after a release.

What is the best way to refine a changelog using a Diataxis-based rubric?▼

Refining a changelog involves applying a Diataxis-based rubric to ensure entries are user-focused and actionable. This Skill audits changelog entries during post-ship workflows, polishing them to maintain high-quality, discoverable documentation that accurately reflects shipped changes.

Can I automatically validate architectural diagrams against recent git diffs?▼

Validating architectural diagrams against git diffs is part of the documentation audit process. This Skill verifies consistency between codebase changes and architectural documentation, ensuring diagrams remain accurate after shipping.

How do I track documentation debt and automate PR body updates?▼

Tracking documentation debt requires auditing discoverability and cross-links across project files. This Skill automates PR body updates and manages version bumps, ensuring documentation remains discoverable while maintaining debt tracking.

Does this documentation audit approach work without external dependencies?▼

This documentation audit approach works without external dependencies, relying entirely on internal scripts. It cross-references markdown files against git diffs to identify stale information and verify consistency, requiring no additional tools or libraries.

When should I use automated documentation synchronization over manual updates?▼

Automated documentation synchronization suits post-ship workflows requiring changelog refinement, version management, and architectural diagram validation. Use it when manual overhead of keeping documentation in sync with code changes becomes unsustainable.