Runbook step format
Every runbook step has these fields, in this order. A step pack is the set of steps that delivers one change, handed over together with its code.
| Field | What goes in it |
|---|---|
| ID | Role, module and number, for example BE-M1-04 |
| Goal | One line: what is true after this step |
| Before | What must already be true: the previous step, a running local stack, a file in place |
| Run | The commands, pnpm first, one block per action, in code blocks. Secrets appear only as placeholders such as <STAGING_DB_PASSWORD> |
| Expect | What you should see, quoted exactly where it matters |
| Check | A query or command that proves the step worked |
| If it fails | What to look at, and when to stop and ask |
| Undo | How to reverse it, or "Not reversible: ask zuki first" |
| Level | L0, L1 or L2 (the automation ladder) |
| Runs | One comment per run on the step's issue: date · who · result · notes |
On this site a step is one page: its ID and level at the top, the other fields as sections. Runs logged before 2026-10-07 stay in the page's Runs section; later runs are comments on the step's issue (D28).