document-release

Name: document-release
Availability: InStock
Author: rmarino550

Compare code changes with project documentation and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files.

Updated Mar 20, 2026

Search Tags:#documentation #consistency #accuracy #code shipping #post-merge updates

Ready to run

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

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires bash, read, write, edit, grep, glob, askuserquestion, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the process of updating documentation after a code shipment, ensuring that all documentation is accurate, up-to-date, and consistent across the project.

Core Features & Use Cases

Automated Documentation Update: Reads all project documents, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, and polishes CHANGELOG voice.
Proactive Updates: Suggests updates after a PR is merged or code is shipped.
Use Case: Ideal for teams looking to streamline their documentation process and maintain high-quality documentation without manual effort.

Quick Start

Run the /document-release command after a PR is merged or code is shipped to update the project documentation.

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 code shipment?▼

Automating documentation updates after a code shipment involves comparing code diffs with project documents to ensure accuracy and consistency across files. This Skill reads project documents, cross-references the diff, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match what shipped.

What is the best way to keep project documentation consistent after a PR merge?▼

Keeping project documentation consistent after a PR merge requires proactively suggesting updates by cross-referencing code changes with existing docs. This approach ensures README, ARCHITECTURE, and CONTRIBUTING files reflect the shipped code while polishing the CHANGELOG voice.

How does automated documentation management work for post-merge code changes?▼

Automated documentation management for post-merge code changes works by reading project files, identifying discrepancies between the diff and existing documentation, and applying targeted edits. It ensures absolute accuracy and consistency across various documentation files without manual effort.

Do I need to manually update my CHANGELOG after shipping code?▼

You do not need to manually update your CHANGELOG after shipping code. This Skill automates the process by comparing code changes and polishing the CHANGELOG voice to match what shipped, ensuring high-quality documentation without manual effort.

Can I use this to update CLAUDE.md and ARCHITECTURE files automatically?▼

Yes, you can update CLAUDE.md and ARCHITECTURE files automatically. The Skill specifically targets these files alongside README and CONTRIBUTING docs, cross-referencing code diffs to ensure all documentation accurately reflects the shipped project state.