Checklist template
When to use
Section titled “When to use”- Shelf:
build/checklists/<topic>/ kind: checklist- Diátaxis mode: reference / verification (confirms procedure completed)
- Readers served: launch gates, QA sign-off, agents treating unchecked items as blockers
Design rationale
Section titled “Design rationale”- Trigger + source link upfront — checklists must say when to run and which procedure they verify (aviation checklist pattern — challenge-response).
- Grouped sections — long flat lists fail scanning; group by subsystem or phase (NN/g grouping).
- Sign-off section — explicit human or ticket closure for audit (SOP evidence pattern).
- Verifiable items only — each
- [ ]must be observable, not vague (“tested enough”) (SMART verification criteria). - Same blocker rule as playbook steps — unchecked = do not proceed (writing-style checklist gate).
Copy-paste skeleton
Section titled “Copy-paste skeleton”---title: "Checklist title"description: One sentence — what this checklist verifies before you proceed.sidebar: label: "Checklist title" order: Ncategory: <topic>kind: checkliststatus: currenttags: [checklist, topic]---
**Use when:** <trigger — e.g. before prod deploy, after vendor update>.**Source procedure:** [Playbook step](/tech-stack/laravel/codecanyon/build/playbooks/setup-new/) or [SOP](/zajlibrary/navigation/library-shelves/resources/reference/build-sops/)
## Before you start
- [ ] <prerequisite>
## <Section name>
- [ ] <verifiable item — how to confirm>- [ ] …
## Sign-off
- [ ] All sections complete- [ ] Evidence recorded (<where>)
:::caution[Do not skip]Unchecked items are blockers — same rule as playbook step checklists.:::Anti-patterns
Section titled “Anti-patterns”- Do not use prose paragraphs instead of checkboxes for verifications.
- Do not orphan checklists without link to source playbook/SOP/runbook.
- Do not mix teaching narrative — link out for context.
Worked example
Section titled “Worked example”- Staging first deploy — grouped
- [ ]sections, sign-off, source procedure link
Sources
Section titled “Sources”- The Checklist Manifesto (Atul Gawande) — verification under complexity.
- Diátaxis — Reference documentation — checklists as lookup verification artifacts.
- Google developer documentation style guide — Procedures — observable pass criteria.
- Writing style → Playbook step pages — shared blocker semantics.
- Writing style → Doc-type spines