Playbook —
Purpose: Repeatable procedure for . Optimized so a competent agent or engineer can execute end-to-end without reading sibling docs. Read when: <Trigger condition — "before merging X", "when adding a new Y", etc.> Skip when: <Negative trigger — "if it's just a typo fix", "if there's already a runbook">. Read next: <1–3 most relevant sibling docs>
Nav: Playbooks Index
When to use
- ✅ <Concrete situation 1>
- ✅ <Concrete situation 2>
- ❌ Not for:
Inputs
| Name | Type | Source | Required |
|---|---|---|---|
<input> |
<type> |
✅ / ❌ | |
<input> |
<type> |
<…> | ✅ / ❌ |
Pre-conditions
- <Permission / access ready>
- <Branch / state requirement>
Steps
Each step states the change, the verification gate, and the rollback. Don't advance without verification.
Step 1 — <Action verb + target>
<exact command>
Why: <one-line rationale referencing a rule/spec/ADR>. Verify: . Rollback: .
Step 2 —
…
Step N —
…
Verification (full procedure done)
- <Test command + expected pass>
- <Lint / type-check passes>
- <Doc updated / reference added>
Failure Modes & Recovery
| Symptom | Likely cause | Action |
|---|---|---|
| <hang / timeout> | ||
Out-of-scope
- <Things this playbook deliberately does NOT cover, with pointer to where they live>
Related
- ADR:
- Runbook: <if there's an alert form>
- Spec:
Stale playbooks are worse than missing ones. If a step here no longer matches reality, fix it the same day you discover the drift.