Docs04 · Operations

Runbook

04-operations/runbooks

A repeatable operational procedure anyone — or any agent — can run cold.

What it is

A step-by-step procedure for an operational task: restoring a backup, rotating a key, clearing a queue, handling an incident. Written so it can be followed without prior context.

When to write it

When a procedure is worth repeating reliably — anything you'd hate to improvise during an incident.

What goes in it

  • When to run it (the trigger)
  • The exact steps — commands and files
  • How to verify it worked
  • Escalation / rollback if it goes wrong

How it fits

Lives in 04-operations/runbooks/. Pairs with the deployment checklist as the project's operational memory.

Get the templatestarter/docs/04-operations/runbooks/runbook.md