document-release

Sync README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts after changes. This Skill reads shipped diffs and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what was released, polishes CHANGELOG language, cleans up TODOS, and optionally bumps the VERSION to keep all docs aligned.

Core Features & Use Cases

  • Doc synchronization: align project docs with shipped changes across key files.
  • Changelog polishing: refine changelog entries to match the actual release voice.
  • Todo cleanup & version bump: tidy TODOS and optionally bump VERSION when appropriate.
  • Post-ship workflow: run after a PR is merged or code is shipped to ensure docs reflect the shipped state.

Quick Start

Run the document-release skill after a ship to synchronize all documentation with the merged changes and shipped state.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-merge documentation sync for README and ARCHITECTURE files?

Automate post-merge documentation sync by scanning shipped diffs and updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes. This aligns project docs automatically after a PR is merged or code is shipped.

What is the best way to polish changelog language after shipping a release?

Polish changelog language after shipping by refining changelog entries to match the actual release voice. This workflow reads shipped changes and updates Markdown files in place to ensure the changelog reflects the released state accurately.

Can I automatically bump VERSION across multiple docs after a ship?

Yes, you can bump VERSION across multiple docs after a ship. This workflow optionally applies version bumps based on configured guidelines, tidies TODOS, and ensures all documentation files remain aligned with the shipped state.

How do I clean up TODOS in documentation after merging a PR?

Clean up TODOS in documentation after merging a PR by running a post-ship workflow that reads repository docs, updates Markdown files in place, and tidies leftover TODOS to keep all project documentation aligned with the merged changes.

Do I need specific dependencies to update Markdown docs in place after a release?

No specific dependencies are required to update Markdown docs in place after a release. This workflow requires only the ability to read and diff repository docs, update Markdown files, polish language, and optionally bump VERSION.

When should I run a post-ship docs synchronization workflow?

Run a post-ship docs synchronization workflow immediately after a PR is merged or code is shipped. This ensures README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md reflect the shipped state and prevents documentation drift.