Skip to content

Stockertim Dictionary · Technology · Artificial intelligence

Runbook

Also called runbooks, run book, operations runbook

In short

A runbook is a short operating guide for a live system that tells the person on duty how to check it, what each alert means and the exact steps to pause, fix or roll back.

  • Beginner
  • Document
  • Checked

In detail

When an automation misbehaves, the person who built it may be on holiday, asleep or no longer with the organisation. A runbook lets someone else act correctly without them. It is written for the person on duty under some pressure, so it uses short numbered steps, names exact screens, settings and contacts, and avoids background explanation that can live elsewhere.

A useful runbook covers the routine and the unusual. Routine: how to confirm the system is healthy, where the dashboards and logs are, which queues to check and how often. Alerts: for each alert, what it means, how to confirm it and what to do first. Controls: how to pause the system, how to roll back to the previous version, how to switch to the manual process and how to restart safely afterwards. Contacts: the owner, a deputy, and suppliers or system administrators with their hours.

Each step should be precise enough to follow without interpretation. "Pause the workflow" is weaker than naming the switch and saying what to check afterwards to confirm the pause worked.

Runbooks decay as systems change. Teams keep them next to the system's other records, update them with every significant change, and test them by having someone other than the author follow a step, such as a rollback, during a quiet period.

Worked example

The runbook for the invoice automation at Brackenridge Wholesale has a section for the alert "exception queue over 50".

  1. Open the exception queue and sort by reason; note the most common reason.
  2. If most items share one supplier, check whether that supplier's invoice layout has changed.
  3. If the layout has changed, pause the automation for that supplier only, using the supplier switch on the settings page.
  4. Tell the accounts team to key that supplier's invoices by hand and record the action in the change log.

A colleague who has never worked on the automation can contain the problem in minutes, following written steps.

In practice

Teams write a runbook before a system goes live, link each alert to its section, keep it with the system's records, update it with every change and rehearse key steps such as pause and rollback at least once a quarter.

Watch out

  • A runbook only its author can follow is not doing its job; test it with someone else.
  • Out-of-date steps are worse than none, because they are trusted.

Learn it properly

Official sources

Facts last checked on 9 November 2026.

Education, not advice: the Stockertim Dictionary explains what terms mean. It never recommends buying or selling anything.

English