document-release

Update core project docs after shipped code changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts as changes are shipped. This Skill reads project docs, cross-references diffs, and updates key files to keep READMEs, architecture notes, contributing guidelines, and CLAUDE notes in sync with what was released.

Core Features & Use Cases

  • Cross-reference shipped changes against documentation and adjust README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md accordingly.
  • Polish CHANGELOG voice, clean up TODOS, and optionally bump the VERSION to reflect the release.
  • Proactively suggest doc updates after a PR merge or code shipment to reduce manual toil and misalignment.

Quick Start

Invoke document-release after a ship to synchronize docs and update CHANGELOG.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automatically update README and CHANGELOG after a PR merge?

You can automatically update README and CHANGELOG after a PR merge by invoking a post-ship documentation Skill that reads project docs, cross-references the shipped diff, and applies synchronized updates to reflect the released code changes.

What is the best way to keep architecture docs in sync with shipped code changes?

Keeping architecture docs in sync relies on cross-referencing shipped diffs against existing documentation, then applying targeted edits to ARCHITECTURE.md and CLAUDE.md to accurately reflect the latest structural and behavioral modifications.

How do I clean up TODOs and polish the CHANGELOG voice after shipping code?

Cleaning up TODOs and polishing the CHANGELOG voice after shipping involves reading the post-merge diff, refining the changelog text for clarity, and removing resolved task markers to maintain accurate release documentation.

Can I automatically bump the VERSION file alongside documentation updates after a release?

Yes, you can optionally bump the VERSION file alongside documentation updates after a release, using Bash, Read, Write, and Edit commands to ensure version tracking stays synchronized with shipped code changes.

Does post-ship documentation synchronization work for repositories without a CLAUDE.md file?

Post-ship documentation synchronization specifically targets repositories containing README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and CHANGELOG.md, so missing core files like CLAUDE.md limit the cross-doc synchronization scope.

Why does documentation drift after shipping code changes?

Documentation drift after shipping code changes occurs because manual updates are often skipped during releases, creating misalignment that requires cross-referencing the shipped diff against project docs to proactively suggest and apply corrective edits.