document-release

Update README, architecture, contribution docs, and CLAUDE.md after releases.

1|Updated Apr 12, 2026
One-click install
npx skills add https://github.com/cheng80/rummipoker --skill document-release-cheng80
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/cheng80/rummipoker/tree/main/.agents/skills/gstack-document-release
Command: npx skills add https://github.com/cheng80/rummipoker --skill document-release-cheng80

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates post-ship documentation updates to keep project documents in sync with what was released. This eliminates drift between shipped code and living docs, reducing confusion for developers and reviewers.

Core Features & Use Cases

  • Diff-aware updates to key docs (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md) to reflect released changes.
  • Changelog polishing and optional version bump during updates.
  • Cross-repo applicability: after PR merges, releases, or ship events.

Quick Start

Run this skill after a release to update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md so they reflect what shipped.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep my README and architecture docs in sync after a release?

To keep documentation in sync after a release, apply diff-aware updates to README and architecture docs by reading shipped changes and modifying the relevant files to reflect the released code, eliminating drift between living docs and shipped code.

What is the best way to automate changelog polishing and version bumping?

The best way to automate changelog polishing and version bumping is using a post-ship workflow that reads diffs, updates contribution guides, refines the changelog voice, and optionally bumps the project version during the documentation update process.

Can I update CLAUDE.md and contribution guides automatically after PR merges?

Yes, you can update CLAUDE.md and contribution guides automatically after PR merges by applying cross-repo diff-aware updates that read the shipped changes and modify the specified documentation files to reflect the merged code.

Does this documentation update approach work across different repositories?

Yes, this documentation update approach works across different repositories because it applies diff-aware updates to key docs after PR merges, releases, or ship events regardless of the specific repository structure.

When do I need to update project documentation after shipping code changes?

You need to update project documentation after shipping code changes when you want to prevent drift between your living docs and the released code, ensuring developers and reviewers avoid confusion caused by outdated READMEs or architecture docs.