Agent skill
Sync Documentation
Use this skill at the end of a task to ensure documentation matches the code.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/documents/sync-documentation
SKILL.md
Sync Documentation
Use this skill to prevent documentation drift after you change behavior, flows, or structure.
Checklist
architecture.md(index)
- New module/service/folder? -> add it to the index
- Changed a main flow? -> update the relevant
docs/architecture/*page(s)
docs/architecture/(leaf docs)
- Update the page(s) that map to the modified area (backend core/data/indicators, chart map, flows, runs/logging, etc.)
- Keep each doc short and linkable (LLM-friendly)
README.md
- New env var? -> document it
- Changed how to run/test? -> update commands
ROADMAP.md
- Completed an item? -> mark it done
- New work discovered? -> add it
Output requirement
In the final response, explicitly list:
Updated: architecture.md(if changed)Updated: docs/architecture/...(if changed)Updated: README.md/Updated: ROADMAP.md(if changed)
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?