document-release

Update core documentation files to reflect shipped code changes.

Updated Feb 5, 2026
One-click install
npx skills add https://github.com/CaltexBevo/ihe-pulse --skill document-release-caltexbevo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/CaltexBevo/ihe-pulse/tree/main/.claude/skills/gstack.bak/document-release
Command: npx skills add https://github.com/CaltexBevo/ihe-pulse --skill document-release-caltexbevo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps documentation aligned with shipped code by performing a post-ship pass that reads diffs, identifies mismatches, and updates core docs accordingly.

Core Features & Use Cases

  • Post-ship doc sync: updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what shipped.
  • CHANGELOG & TODOS polish: polishes CHANGELOG voice, cleans up TODOS, and ensures notes describe the shipped state.
  • VERSION guidance: suggests or prompts a version bump when changes warrant it, while preserving intent and history.

Quick Start

Run a post-ship doc update to scan diffs and refresh docs across the project.

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

Post-ship documentation synchronization reads code diffs, identifies mismatches, and updates core docs like README.md and ARCHITECTURE.md to accurately reflect the shipped state.

What is the best way to keep a CHANGELOG aligned with shipped features?▼

Keeping a CHANGELOG aligned involves performing a post-ship doc pass that polishes CHANGELOG voice, cleans up TODOS, and ensures notes describe the shipped state without losing intent or history.

How do I update README and ARCHITECTURE files based on version control diffs?▼

Update README.md and ARCHITECTURE.md by scanning version control diffs after a ship and applying safe edits that preserve history while synchronizing the documentation with the latest code changes.

Does this documentation workflow suggest VERSION bumps automatically?▼

Yes, the documentation workflow suggests or prompts a VERSION bump when shipped changes warrant it, ensuring versioning stays aligned while preserving existing history and intent.

Can I clean up TODOS alongside CHANGELOG updates in a post-ship pass?▼

Yes, you can clean up TODOS alongside CHANGELOG updates during a post-ship pass, ensuring both files accurately describe the shipped state while maintaining safe edits across the project.

When should I run a post-ship documentation synchronization pass?▼

Run a post-ship documentation synchronization pass whenever code changes are shipped and you need to scan diffs to refresh docs, update CONTRIBUTING.md or CLAUDE.md, and interact with CI checks.