Plan documents capture design decisions that span multiple sessions. Each plan is a snapshot of the reasoning at the time — subsequent plans may supersede earlier ones as the project evolves.
Plans are temporary. When a plan is fully implemented, it graduates:
- The plan file is removed from this folder.
- The final architecture is documented in
docs/dev/— either updated into existing dev docs or captured in a new one. - End-to-end use-case scenarios are added to
tests/qa/.
Once graduated, the dev docs and use-case docs are the permanent record. The plan file is no longer needed — git history preserves it if someone needs the original design reasoning.
Each plan should cover:
- Synopsis — 1-2 line summary
- Decisions — table of choices made, with rationale where non-obvious
- Architecture — module layout and data flow
- Dependencies — runtime, built-in, and dev deps