skills.rest
legotec73
legotec73COMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Update project docs from diffs after code shipment.

Updated Apr 13, 2026
Search Tags:#changelog#documentation#diff#docs#version-bump#post-ship
One-click install
npx skills add https://github.com/legotec73/gstack --skill document-release-legotec73
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/legotec73/gstack/tree/main/document-release
Command: npx skills add https://github.com/legotec73/gstack --skill document-release-legotec73

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping code, this skill ensures all project documentation stays accurate by reading diffs, updating key docs, and polishing changelog and todos. It cross-references what shipped and aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the new reality.

Core Features & Use Cases

  • Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
  • Polish changelog voice, clean up todos, and optionally bump the version.
  • Run after a PR merge or code shipment to prepare post-ship documentation updates.

Quick Start

Run the document-release skill after shipping to automatically update and polish 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 after merging a PR?▼

To update project documentation after a PR merge, you can run the document-release skill which reads code diffs and synchronizes README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.

What is the best way to keep a changelog and README aligned with code changes?▼

The best way to keep a changelog and README aligned is to cross-reference git diffs post-ship and apply updates across all key project documents to match the new code reality.

Can I automatically clean up TODOS and bump the VERSION after a shipment?▼

Yes, you can clean up TODOS and optionally bump the VERSION by running a post-ship documentation workflow that polishes the changelog voice and updates project files.

Do I need to manually cross-reference diffs to update CLAUDE.md and ARCHITECTURE docs?▼

No, you do not need to manually cross-reference diffs. A post-ship documentation skill automatically reads diffs to synchronize CLAUDE.md, ARCHITECTURE, and other key docs.

When should I run a post-ship documentation update workflow?▼

You should run a post-ship documentation update workflow immediately after a PR merge or code shipment to ensure all project docs accurately reflect the latest changes.

Related Skills

Explore More Content & Communication Skills→
shinprshinpr
29

recipe-review

Validate Design Doc compliance and security requirements for code implementations.

Community
Advanced
pythoninthegrassespythoninthegrasses
1

changelog-automation

Generate changelogs and release notes from commits, PRs, and tags.

Official
Advanced
mvillmowmvillmow
18

doc-validate-markdown

Validate Markdown formatting and style compliance with markdownlint.

Community
Intermediate
MichaelSolatiMichaelSolati

changelog

Generate categorized internal and player-facing changelogs from git history and sprint reports.

Community
Advanced