eddieran Doc Sync
Use this skill when code changes may have made READMEs, CLI docs, API docs, or examples stale.
Agent Compatibility
- Claude Code: supported
- Codex: supported
Inputs
- The changed code or commit range
- The documentation surface that claims to describe that code
- Release notes, CLI help output, or API schemas when available
Workflow
- Enumerate the behavior that changed in code.
- Find the documentation pages that claim to describe that behavior.
- Compare signatures, commands, flags, examples, and defaults.
- Report stale docs before proposing rewrites.
- Prefer minimal, accurate doc updates over broad rewording.
Output Contract
- Stale documentation findings first
- Exact files that drifted
- The implementation fact that now differs
- The smallest accurate doc update
Guardrails
- Do not rewrite docs that are already correct.
- Do not invent undocumented features.
- Distinguish between wording polish and factual drift.