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)