document-release

Update project documentation to match shipped code changes from diffs.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates across project docs by diff, ensuring README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md reflect shipped changes, polishing CHANGELOG and TODOS, and optionally bump VERSION.

Core Features & Use Cases

  • Reads project docs, cross-references the diff, updates docs to match shipped state.
  • Proactively suggests docs updates after PR merges or code shipping.
  • Optional version bump and changelog polishing.

Quick Start

Use when asked to "update the docs", "sync documentation", or "post-ship docs".

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update README and ARCHITECTURE docs after a pull request merge?

To update project documentation after a pull request merge, you can automate the process by reading code diffs to sync README, ARCHITECTURE, and CONTRIBUTING files with the shipped changes, ensuring docs reflect the latest state without manual edits.

What is post-ship documentation automation?

Post-ship documentation automation aligns project docs with the latest shipped changes by analyzing diffs. It proactively suggests updates to README, ARCHITECTURE, and CONTRIBUTING files after code shipments, ensuring documentation matches the deployed state.

How do I sync a CHANGELOG with a version bump automatically?

You can sync a CHANGELOG with a version bump by using diff analysis to polish the changelog voice and optionally bump the VERSION file, ensuring release notes and versioning stay consistent with the shipped code.

Can I automatically clean up TODOS after shipping code?

Yes, you can automatically clean up TODOS after shipping code by analyzing the shipped diff. This post-ship docs update process scans completed changes and removes or updates resolved TODO items to match the current codebase state.

Does diff analysis work for updating CLAUDE.md files?

Yes, diff analysis works for updating CLAUDE.md files. It cross-references the shipped code changes against existing project documentation and applies necessary updates to CLAUDE.md to ensure it matches the new project architecture.

When should I not use automated documentation updates?

You should avoid automated documentation updates when changes are purely cosmetic or do not affect project behavior, as diff analysis targets architectural or functional modifications that impact README, ARCHITECTURE, or CONTRIBUTING files.