document-release
Installation
SKILL.md
Document Release
Post-ship documentation audit and sync: reads the diff, updates docs to match what actually shipped, and never silently bumps versions or rewrites narrative content.
Purpose
Keep project documentation synchronized with shipped code by cross-referencing the git diff against every doc file, auto-applying factual corrections, and asking the user before making subjective or structural documentation changes.
Trigger
Apply when user requests:
- "document release", "sync docs", "update readme after ship", "post-ship docs"
- "docs out of date", "更新文件", "發布後同步文件", "README 過時了"
- Automatically recommended after
shiporcanarycompletes
Do NOT trigger for:
- Before code is committed — docs cannot be synced against uncommitted changes
- General documentation writing without a corresponding code change — use
article-writingor direct editing