document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped code diffs.

Updated Dec 26, 2025
One-click install
npx skills add https://github.com/tony30552001/Genpic-master --skill document-release-tony30552001
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/tony30552001/Genpic-master/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/tony30552001/Genpic-master --skill document-release-tony30552001

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are automated to keep all shipped docs in sync with code changes. It reads diffs, updates key docs, polishes changelog language, cleans up TODOS, and can bump the version when required.

Core Features & Use Cases

  • Reads project docs and cross-references shipped changes against release notes.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION after a release.
  • Proactively suggests documentation updates after PR merges or code ships.

Quick Start

After a release, run this skill to align and polish project documentation across core files.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate changelog updates after a code release?

Automating changelog updates involves reading shipped code diffs and cross-referencing them with your project docs. This skill aligns README, ARCHITECTURE, and CONTRIBUTING files to reflect the shipped changes, while polishing the changelog voice and cleaning up TODOS.

What is the best way to sync README and ARCHITECTURE docs with recent code changes?

Syncing README and ARCHITECTURE docs requires cross-referencing shipped diffs against existing documentation. This skill reads the project diff, updates core docs to match the release, and ensures your CLAUDE.md and CONTRIBUTING files reflect the latest codebase state.

Can I automatically bump the VERSION file after a release?

Yes, you can bump the VERSION file automatically after a release. When running post-ship documentation updates, this skill evaluates the shipped changes and applies an optional version bump alongside updating core project files and polishing the changelog.

How do I clean up TODOS and polish changelog voice in project documentation?

Cleaning up TODOS and polishing changelog voice is done by applying automated documentation updates post-release. This skill adjusts the changelog language for consistency, removes resolved TODO comments, and ensures the documentation matches the shipped diff.

Does this documentation update tool work with CLAUDE.md and CONTRIBUTING files?

Yes, this documentation update tool explicitly works with CLAUDE.md and CONTRIBUTING files. It reads these core project docs, cross-references them with the shipped code diff, and updates their content to accurately reflect the latest release changes.

When do I need to run post-ship documentation updates?

Post-ship documentation updates are needed after a release or PR merge when code changes alter existing functionality. Running this skill ensures your README, ARCHITECTURE, and changelog stay synchronized with the shipped diff without manual editing.