Use when creating or editing work item files in docs/work and their rows on docs/project/board.md. Defines file layout, header fields, and sections.
Work items¶
Files¶
docs/work/W-NNN-<slug>.md: one file per item.NNNcomes fromnext_idin the board frontmatter, which is then incremented.docs/work/archive.md: finished items.docs/project/board.md: one row per open item (state, priority order). OnlyTriagewrites it.docs/project/inbox.md,docs/project/epics.md: unsorted requests and epics.
Header¶
# W-NNN: <title>
- Type: feature | bug | refactor | chore | spike
- Target: packages/<name> | apps/<name>
- Size: S | M
- State: inbox | ready | active | blocked | review | accept
- Depends: W-NNN, ...
- Epic: <name>
- Refs: <spec, brief, issue>
Sections¶
## Goal: one or two sentences.- Type-specific: feature:
## Spec(path and requirement IDs); bug:## Observed,## Expected,## Repro,## Severity; refactor:## Invariants; spike:## Question. ## Steps: ordered checkboxes, written byPlanWriter. Each step lists its paths and requirement IDs. A scaffold step is marked(scaffold).## Log: dated one-line entries, append only.
Rules¶
- Tick a step's checkbox only when its tests and checks pass.
- Never delete Log lines.