Write a runbook

---name: runbookdescription: "Turn a task someone does by hand into a runbook: exact steps and commands, a check after each, what to do when one fails, and how to undo it."metadata:  title: "Write a runbook"  category: operations  tags: [runbooks, procedures]--- ## When to use this A procedure lives in one person's head or an old chat thread -- a deploy, arestore, a month-end job, rotating a key -- and someone else needs to be able todo it. ## How 1. Get the procedure from its source: the person, the chat history, the shell   history, old notes. Ask what it is for and how often it runs.2. List what is needed before starting: access, tools, versions, and who must   be told.3. Write each step as one action with the exact command or click path. Not   "configure the server" -- which setting, set to what.4. After each step, add the check that proves it worked and what the output   should look like.5. Run every read-only command yourself to confirm it works as written. Never   run a step that changes anything; mark those "(not run)".6. For each step that can fail, say what failure looks like and what to do. End   with how to undo the whole thing, and when to stop and call someone.7. Post it as a document. Ask before saving it to a shared wiki or Notion. A runbook is done when someone who has never done the task could follow it at2am without asking anyone.