document-release

Name: document-release
Availability: InStock
Author: prestonigo

Synchronize project documentation with shipped code changes after release.

Updated Aug 27, 2026

Search Tags:#documentation #diff #docs #update #CHANGELOG #polish #version-bump

Ready to run

npx skills add https://github.com/Prestonigo/Claude-Skills --skill document-release-prestonigo

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship drift is real. This skill automatically reads shipped changes, cross-references them against project docs, and updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what was shipped, saving manual rework.

Core Features & Use Cases

Reads project diffs and updates the main documentation to match the release state.
Polishes the CHANGELOG voice, cleans up TODOS, and can bump the VERSION when appropriate.
Use after a PR is merged or code is shipped to keep docs aligned and release-ready.

Quick Start

Run the document-release skill after shipping to synchronize and polish all project docs.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I update project documentation to match a new code release?▼

To update project documentation to match a new code release, this Skill cross-references shipped diffs against README.md, ARCHITECTURE.md, and CONTRIBUTING.md, automatically applying safe, idempotent edits to synchronize the docs with the release state.

What is the best way to polish a CHANGELOG after shipping code?▼

Polishing a CHANGELOG after shipping involves refining the release voice, cleaning up TODOS, and optionally bumping the version. This Skill automates that process by reading project diffs and applying those formatting updates directly.

Does updating post-ship docs require manual repository structure knowledge?▼

Updating post-ship docs requires knowledge of the repository structure to safely navigate and modify files. This Skill uses Bash, Read, Write, Edit, and Grep to perform safe, idempotent updates based on that underlying structure.

Can I synchronize CLAUDE.md and ARCHITECTURE.md automatically after a PR merge?▼

You can synchronize CLAUDE.md and ARCHITECTURE.md automatically after a PR merge by running this Skill. It reads the shipped changes and updates these specific project files to reflect the latest release state without manual rework.

When should I run documentation synchronization for post-ship drift?▼

You should run documentation synchronization for post-ship drift immediately after a PR is merged or code is shipped. This prevents documentation from falling out of alignment with the actual codebase changes over time.

What are the limitations of automating documentation updates with a diff?▼

Automating documentation updates with a diff relies on cross-referencing project files and requires understanding the repository structure. It performs safe, idempotent updates but may require user input via AskUserQuestion for complex structural changes.