document-release

Update project documentation files to reflect shipped changes after PR merges.

Updated Oct 25, 2025
One-click install
npx skills add https://github.com/shaythegay13/serenity-pocket-app-final --skill document-release-shaythegay13
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/shaythegay13/serenity-pocket-app-final/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/shaythegay13/serenity-pocket-app-final --skill document-release-shaythegay13

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This tool reads all project docs, cross-references the diff, and updates core documentation files to reflect shipped changes.

Core Features & Use Cases

  • Updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match shipped changes
  • Polishes CHANGELOG voice and cleans up TODOS
  • Optionally bumps VERSION after a PR merge when appropriate

Quick Start

Run the document-release workflow to update all project docs based on the latest changes and diffs.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-ship documentation updates after a PR merge?

To automate post-ship documentation updates, this Skill reads project docs, cross-references diffs, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to accurately reflect what shipped.

Can I automatically update my CHANGELOG and clean up TODOS when a release ships?

Yes, you can update your CHANGELOG and clean up TODOS when a release ships. The workflow polishes the CHANGELOG voice and removes completed TODOS based on the latest merged diffs.

What is the best way to keep README and ARCHITECTURE docs in sync with merged code changes?

Keeping README and ARCHITECTURE docs in sync with merged code changes requires cross-referencing diffs against existing project files. This workflow automates that process using Bash, Read, Write, Edit, and Grep tools.

Does this documentation workflow require any external dependencies or specific components?

No external dependencies or specific components are required to run this workflow. It operates autonomously using a guided process with built-in tools like Glob, Grep, Bash, and AskUserQuestion.

Can I automatically bump the VERSION file as part of my post-release documentation workflow?

Yes, you can bump the VERSION file as part of your post-release documentation workflow. The process optionally increments the VERSION number when appropriate after reading and cross-referencing shipped diffs.

When should I use an automated documentation workflow instead of manual updates?

You should use an automated documentation workflow instead of manual updates when you need to consistently synchronize README, ARCHITECTURE, and CONTRIBUTING files with shipped diffs immediately after PR merges to prevent documentation drift.