Sync project documentation with implementation in Claude Code
Identify affected README sections, documents, and templates after a change, then verify prerequisites and usage.
中文Install in Claude Code
A Claude Code workspace with the implementation and documentation. Invoke the slash skill explicitly and supply a brief change summary.
- Review `.claude/skills/docs-sync/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.claude/skills/docs-sync/` in your project and save the reviewed file as `.claude/skills/docs-sync/SKILL.md`.
- Start Claude Code from that project's root, then select `/docs-sync` in the slash menu.
Example task
A fictional site now exports only the selected venue instead of every event. The old README still says all events, duplicated in onboarding. The fixture is `{feature:'Export list',scope:'selected venue',requires:'choose a venue'}`.What to check
Update the main instruction to `scope=selected venue; prerequisite=choose a venue`. Link to it elsewhere, add one onboarding sentence on choosing a venue, and verify the visible button name.
Original SKILL.md on GitHub · Updated
Frequently asked question
How can I prevent contradictory documentation after a feature change?
Find the pages affected by implementation. Maintain a complete instruction in one place, link from other pages, and verify terminology, paths, and prerequisites.