document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update. Reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when asked to "update the docs", "sync documentation", or "post-ship docs".

Core Features & Use Cases

  • Automatically reads and adjusts documentation to reflect shipped changes across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
  • Polishes CHANGELOG voice, tidies TODOS, and can bump the project VERSION when appropriate.
  • Use when you want a post-ship consistency pass, typically after PR merges or code shipments.

Quick Start

Run this after shipping to auto-sync docs across the repo and polish the changelog before PR.

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 documentation after shipping code changes?

To automatically update documentation after shipping, you can trigger a post-ship docs pass that reads project diffs and syncs README, ARCHITECTURE, and CONTRIBUTING files to match the shipped code.

What is the best way to sync CLAUDE.md and CHANGELOG files with recent diffs?

Syncing CLAUDE.md and CHANGELOG files involves cross-referencing your project diff to update key documents, polishing the changelog voice, and cleaning up TODOS to reflect what actually shipped.

Can I automatically bump VERSION and clean up TODOS during a docs sync?

Yes, during a documentation sync you can automatically clean up TODOS and bump the project VERSION when requested, ensuring post-ship consistency across all updated files.

When do I need to run a post-ship documentation consistency pass?

You need a post-ship documentation consistency pass typically after PR merges or code shipments, ensuring that README, ARCHITECTURE, and CLAUDE.md accurately reflect the latest shipped changes.

Does this documentation update approach work without external dependencies?

Yes, this documentation update approach works without external dependencies, reading existing project docs and diffs directly to update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files automatically.