Skip to content

New Runbook Template

Copy this structure when a page needs to guide a repeatable task.

---
title: Runbook Name
description: The task this page helps someone complete.
tableOfContents: false
---
## Preconditions
- required access
- required tools
- required state
## Steps
1. do the action
2. verify the result
3. continue only if validation passes
## Validation
- expected output
- dashboards or logs to check
## Rollback
- how to undo the change safely
  • Write steps so that tired future-you can still follow them.
  • Put risky or irreversible actions behind explicit validation steps.
  • Link out to architecture pages when a reader needs background, but keep the runbook operational.