next phase
This commit is contained in:
1 parent
6387f4455b
commit
782e5dc440
14 files changed
+1280
-27
No files matched your search
+69
-20
@@ -1,3 +1,18 @@
|
||||
# Phase folder template
|
||||
|
||||
Copy this layout to `plan/<short-name>/`. See [`README.md`](README.md) for the rules (Do not touch, contracts, claiming a workstream).
|
||||
|
||||
```
|
||||
plan/<short-name>/
|
||||
README.md phase overview (template below)
|
||||
contracts.md shared interface contracts (omit if streams share nothing)
|
||||
decisions.md open decisions and records
|
||||
ws-<x>-<name>.md one per workstream (template below)
|
||||
```
|
||||
|
||||
## `README.md` (phase overview)
|
||||
|
||||
```markdown
|
||||
# Phase N: <name>
|
||||
|
||||
| Field | Value |
|
||||
@@ -8,44 +23,78 @@
|
||||
| Depends on | |
|
||||
|
||||
## Goal
|
||||
|
||||
What changes for users or operators once this phase is done, in a few sentences.
|
||||
|
||||
## Scope
|
||||
|
||||
In scope:
|
||||
|
||||
-
|
||||
|
||||
Out of scope:
|
||||
|
||||
-
|
||||
|
||||
## Workstreams
|
||||
## Grounding in the current code
|
||||
The files and types the work builds on.
|
||||
|
||||
One block per independent track. Name the files each owns so tracks do not collide.
|
||||
## Workstream index
|
||||
| ID | File | Owner | Depends on | Can start when | Owned files |
|
||||
|---|---|---|---|---|---|
|
||||
|
||||
### WS-X: <name>
|
||||
### Dependency graph
|
||||
(ascii)
|
||||
|
||||
- Goal:
|
||||
- Owned files:
|
||||
- Depends on:
|
||||
- Tasks (IDs to be ticked in `TODO.md`):
|
||||
- **X1**
|
||||
- Done when:
|
||||
### Parallel lanes
|
||||
Which workstreams may run concurrently from day one, and what each later wave unlocks.
|
||||
|
||||
## Open decisions
|
||||
## Risks
|
||||
-
|
||||
|
||||
## Verification plan
|
||||
Numbered, concrete steps.
|
||||
|
||||
## Exit criteria
|
||||
Concrete, checkable. Commands to run and behaviour to demonstrate, for example `cargo clippy --all-targets -- -D warnings`, `cargo test`, and a live check on a real host.
|
||||
-
|
||||
```
|
||||
|
||||
## `contracts.md`
|
||||
|
||||
Rust signatures, JSON shapes, config keys and fakes shared by more than one stream; a "change rule" stating that contracts change only here, with a log note in each affected workstream file.
|
||||
|
||||
## `decisions.md`
|
||||
|
||||
```markdown
|
||||
| ID | Question | Options | Recommendation | Decision |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
```
|
||||
|
||||
## Risks
|
||||
## `ws-<x>-<name>.md` (workstream file)
|
||||
|
||||
-
|
||||
```markdown
|
||||
# WS-X: <name>
|
||||
|
||||
## Exit criteria
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| Status | Not started / In progress / Blocked / Done |
|
||||
| Owner | |
|
||||
| Depends on | |
|
||||
| Blocks | |
|
||||
| Can start when | |
|
||||
| Owned files | |
|
||||
| Do not touch | files owned by other streams; for shared files, the exact integration seam and which stream edits it first |
|
||||
|
||||
Concrete, checkable. Commands to run and behaviour to demonstrate, for example `cargo clippy --all-targets -- -D warnings`, `cargo test`, and a live check on a real host.
|
||||
## Goal
|
||||
|
||||
-
|
||||
## Tasks (IDs to be ticked in `TODO.md`)
|
||||
- **X1**
|
||||
|
||||
## Inputs
|
||||
Which `contracts.md` sections this stream relies on; which fakes it uses.
|
||||
|
||||
## Done when
|
||||
|
||||
## Handoff
|
||||
What this stream must publish for others.
|
||||
|
||||
## Log
|
||||
- YYYY-MM-DD: <entry>
|
||||
```
|
||||
Reference in new issue
Block a user