document-release

Synchronize project documentation with shipped release changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what was delivered. This Skill automatically reads release changes and updates core docs so they stay aligned with shipped features.

Core Features & Use Cases

  • Auto-synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the latest release notes.
  • Polish the CHANGELOG to reflect what shipped and clean up TODOS for the next cycle.
  • Optionally bump the VERSION when changes warrant a new release to keep versioning consistent.

Quick Start

After shipping, run the document-release workflow to refresh docs across the project without manual edits.

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 release?

To automatically update README and CHANGELOG after a release, you can use a documentation synchronization tool that reads release diffs and applies non-destructive edits to keep docs aligned with shipped features.

What is the best way to sync project documentation with shipped changes?

The best way to sync project documentation with shipped changes is to use a diff-analysis workflow that automatically updates core docs like ARCHITECTURE and CONTRIBUTING, polishes the CHANGELOG, and cleans up TODOS.

How does diff-analysis work for post-release documentation updates?

Diff-analysis for post-release documentation updates works by reading the differences between code versions, then applying non-destructive edits to project files to ensure they reflect what was actually released.

Can I automatically bump VERSION and clean up TODOS when shipping a release?

Yes, you can automatically bump VERSION and clean up TODOS when shipping a release by running a post-ship workflow that evaluates changes and updates versioning consistency alongside documentation.

When do I need to update CLAUDE.md and CONTRIBUTING files after shipping?

You need to update CLAUDE.md and CONTRIBUTING files after shipping when your release includes changes that affect project architecture, contributor guidelines, or core features, ensuring docs stay consistent with the shipped product.

Are non-destructive edits applied when synchronizing docs with the latest release?

Yes, non-destructive edits are applied when synchronizing docs with the latest release, ensuring that existing manual documentation content is preserved while automatically aligning descriptions with shipped features.