26 lines
1.6 KiB
Markdown
26 lines
1.6 KiB
Markdown
# Planning the next phase
|
|
|
|
`plan/` is only for planning the next big piece of work, before it starts. It is empty of plans while the current board is clean.
|
|
|
|
Where other things live:
|
|
|
|
| What | Where |
|
|
|---|---|
|
|
| Work tracking and checkboxes | [`../TODO.md`](../TODO.md) (tick boxes only there) |
|
|
| Current design and decisions | [`../ARCHITECTURE.md`](../ARCHITECTURE.md) |
|
|
| Long-form docs | [`../docs/`](../docs/README.md) |
|
|
| Records of finished workstreams | [`../docs/workstreams/`](../docs/workstreams/) |
|
|
|
|
## Proposing a phase plan
|
|
|
|
1. Copy [`TEMPLATE.md`](TEMPLATE.md) to `plan/<short-name>.md` (for example `plan/phase-5-alerting.md`).
|
|
2. Fill in:
|
|
- **Goal**: what changes for users or operators, in a few sentences.
|
|
- **Scope**: what is in, and explicitly what is out.
|
|
- **Workstreams**: independent tracks with owned files, dependencies and done criteria, so they can run in parallel without merge conflicts.
|
|
- **Open decisions**: questions that need a human call, each with options and a recommendation.
|
|
- **Exit criteria**: how you will know the phase is done (commands to run, behaviour to demonstrate).
|
|
3. Review and settle the open decisions in the plan file.
|
|
4. When the plan is accepted, move the work into [`../TODO.md`](../TODO.md): add the phase milestone and one checklist per workstream with stable task IDs. Fold the accepted decisions into the Decisions section of [`../ARCHITECTURE.md`](../ARCHITECTURE.md).
|
|
5. When the phase finishes, move the plan file (and any per-workstream notes) to `docs/workstreams/` as an archived record and collapse its tasks in `TODO.md` into the Completed table.
|