document-release

Update project documentation files to reflect merged code changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines post-ship documentation updates, ensuring accuracy, consistency, and readiness of all documentation files.

Core Features & Use Cases

  • Automated Documentation Updates: Updates README, Architecture, CONTRIBUTING, and CLAUDE.md to reflect recent code changes.
  • Cross-File Consistency Checks: Ensures all documentation files align without factual inconsistencies.
  • CHANGELOG Voice Polishing: Refines the voice of the CHANGELOG for better readability and engagement.
  • Use Case: After merging a feature branch, run this Skill to update all documentation files to match the shipped codebase.

Quick Start

Run the /document-release command to update all project documentation after code is merged into the main branch.

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 merging code into the main branch?

Automating post-merge documentation updates involves reading project docs, cross-referencing the code diff, and updating relevant files. This Skill targets software development workflows to maintain accurate, up-to-date project documentation automatically after a ship.

What is the best way to keep README and Architecture files consistent with recent code changes?

Keeping README and Architecture files consistent requires cross-file consistency checks against the shipped codebase. This Skill reads documentation, cross-references code diffs, and updates relevant files to ensure all project documentation aligns without factual inconsistencies.

How does a post-merge documentation update tool handle CHANGELOG generation?

A post-merge documentation update tool handles CHANGELOG generation by refining the voice of the CHANGELOG for better readability and engagement. It reads the project documentation and code diff to polish entries after the feature branch is merged.

Can I update CONTRIBUTING and CLAUDE.md files automatically alongside the codebase?

You can update CONTRIBUTING and CLAUDE.md files automatically alongside the codebase. This Skill updates README, Architecture, CONTRIBUTING, and CLAUDE.md files to reflect recent code changes and ensures cross-file consistency after merging.

Do I need bash and grep to run an automated post-ship documentation update process?

You need bash, read, write, edit, grep, glob, and askuserquestion to run this automated post-ship documentation update process. These dependencies are required for the tool to read diffs, search files, and apply updates to the project documentation.

When should I avoid using an automated tool for post-merge documentation updates?

You should avoid using an automated tool for post-merge documentation updates when the code diff lacks structural changes impacting documentation, or when manual review is required for highly sensitive architectural changes before updating the project files.