TODOS-format.md
61 lines · review/TODOS-format.md at 3f79d81
Most marks come from matching words in the file, so treat them as pointers.
1# TODOS.md Format Reference
3Shared reference for the canonical TODOS.md format. Referenced by `/ship` (Step 14) and `/plan-ceo-review` (TODOS.md updates section) to ensure consistent TODO item structure.
5---
TODOS.md Format Reference
Shared reference for the canonical TODOS.md format. Referenced by /ship (Step 14) and /plan-ceo-review (TODOS.md updates section) to ensure consistent TODO item structure.
Raw lines 1 to 6
7## File Structure
9```markdown
10# TODOS
12## <Skill/Component> ← e.g., ## Browse, ## Ship, ## Review, ## Infrastructure
13<items sorted P0 first, then P1, P2, P3, P4>
15## Completed
16<finished items with completion annotation>
17```
19**Sections:** Organize by skill or component (`## Browse`, `## Ship`, `## Review`, `## QA`, `## Retro`, `## Infrastructure`). Within each section, sort items by priority (P0 at top).
21---
File Structure
# TODOS
## <Skill/Component> ← e.g., ## Browse, ## Ship, ## Review, ## Infrastructure
<items sorted P0 first, then P1, P2, P3, P4>
## Completed
<finished items with completion annotation>Sections: Organize by skill or component (## Browse, ## Ship, ## Review, ## QA, ## Retro, ## Infrastructure). Within each section, sort items by priority (P0 at top).
Raw lines 7 to 22
23## TODO Item Format
25Each item is an H3 under its section:
27```markdown
28### <Title>
30**What:** One-line description of the work.
32**Why:** The concrete problem it solves or value it unlocks.
34**Context:** Enough detail that someone picking this up in 3 months understands the motivation, the current state, and where to start.
36**Effort:** S / M / L / XL
37**Priority:** P0 / P1 / P2 / P3 / P4
38**Depends on:** <prerequisites, or "None">
39```
41**Required fields:** What, Why, Context, Effort, Priority
42**Optional fields:** Depends on, Blocked by
44---
TODO Item Format
Each item is an H3 under its section:
### <Title>
**What:** One-line description of the work.
**Why:** The concrete problem it solves or value it unlocks.
**Context:** Enough detail that someone picking this up in 3 months understands the motivation, the current state, and where to start.
**Effort:** S / M / L / XL
**Priority:** P0 / P1 / P2 / P3 / P4
**Depends on:** <prerequisites, or "None">Required fields: What, Why, Context, Effort, Priority Optional fields: Depends on, Blocked by
Raw lines 23 to 45
46## Priority Definitions
48- **P0** — Blocking: must be done before next release
49- **P1** — Critical: should be done this cycle
50- **P2** — Important: do when P0/P1 are clear
51- **P3** — Nice-to-have: revisit after adoption/usage data
52- **P4** — Someday: good idea, no urgency
54---
Priority Definitions
- P0 — Blocking: must be done before next release
- P1 — Critical: should be done this cycle
- P2 — Important: do when P0/P1 are clear
- P3 — Nice-to-have: revisit after adoption/usage data
- P4 — Someday: good idea, no urgency
Raw lines 46 to 55
56## Completed Item Format
58When an item is completed, move it to the `## Completed` section preserving its original content and appending:
60```markdown
61**Completed:** vX.Y.Z (YYYY-MM-DD)
Completed Item Format
When an item is completed, move it to the ## Completed section preserving its original content and appending:
**Completed:** vX.Y.Z (YYYY-MM-DD)