document-release

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

10|3|Updated Mar 25, 2026

Search Tags:#documentation #claude.md #CHANGELOG #docs-sync #version-bump #diff-check

Ready to run

npx skills add https://github.com/olaafrossi/FoamPilot --skill document-release-olaafrossi

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/olaafrossi/FoamPilot/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/olaafrossi/FoamPilot --skill document-release-olaafrossi

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

Synchronizes README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the latest shipped changes.
Polishes CHANGELOG tone and cleans up TODOS.
Optionally bumps the project VERSION when appropriate.

Quick Start

Run the document-release workflow after a ship to synchronize all docs with the latest changes.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I automate documentation updates after a release?▼

Automating post-ship documentation updates involves scanning project docs, comparing them against shipped diffs, and aligning README, ARCHITECTURE, and CONTRIBUTING files with the released changes.

How do I sync CLAUDE.md and CHANGELOG with shipped code changes?▼

Syncing CLAUDE.md and polishing the CHANGELOG requires cross-referencing the post-ship diff, updating project documentation to match what shipped, and refining the CHANGELOG tone to reflect the release.

Can I automatically bump the VERSION file when syncing documentation?▼

Yes, the post-ship documentation workflow optionally bumps the project VERSION when appropriate, alongside synchronizing README, ARCHITECTURE, and CONTRIBUTING files with the latest shipped changes.

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

Run post-ship docs synchronization immediately after a ship or release to align project documentation with the shipped changes, clean up TODOS, and polish the CHANGELOG voice.

What's the best way to clean up TODOS and align docs with a new release?▼

The best way to align docs and clean up TODOS is running an automated post-ship workflow that reads all project docs, cross-references the diff, and updates files to match what shipped.