Operating tool / Documentation

Runbook Builder

Turn a repeat task into a procedure another person can follow.

Privacy: Entries stay in browser memory. They are not sent to or stored by this site, and there is no autosave. Reset or reload clears them. A Markdown download is a file you intentionally retain on your device; delete it yourself when no longer needed. Ordinary hosting page-request logs are separate from these entries.

Write a procedure another technician can follow. Define the evidence for success and the point where they must stop. This builder writes documentation; it does not execute commands or validate a procedure.

Use role names and safe references. Do not enter passwords, tokens, private tickets or customer information. The completed example is an original fictional training exercise, not a production instruction.

Procedure details

TitleScope and triggerOwner roleReview date or review triggerPrerequisites and authorizationFinal verification and evidenceRollback or safe stopping pointEscalation and stop conditions

Ordered steps

Give each step one action and an observable expected result. Use “Stop if” for a condition that prevents the next step.

Step 1ActionExpected result / evidenceStop if

Step 2ActionExpected result / evidenceStop if

Step 3ActionExpected result / evidenceStop if

Use 1–20 steps. Remove last step discards its text.

Markdown preview

Blank fields remain marked “Not supplied”. Review the text before using it.

Worked example: review a handoff note

This is the complete material behind “Load fictional example”. TRAIN-0412 is an invented training ticket; the desk, printer and people are fictional. You can repeat the whole review from this page.

1. The note as written (before)

TRAIN-0412 handoff, Tue 18:40, evening technician
Front desk printer still down. Restarted it at 17:30 and cleared the queue, still shows offline. Tried the usual. Vendor said they'd call back maybe tomorrow? Might be the same thing as the mailbox issue last week. Admin login for the print server is in my notes. Someone should check it in the morning.

2. Sentence-by-sentence review

Mark each sentence as a fact, vague, unconfirmed, speculation, unsafe or missing an owner. Keep only facts the note supports. Anything else becomes UNKNOWN with a person to ask.

“Front desk printer still down.” Fact. Keep it as the status and name the observed symptom: shows offline.
“Restarted it at 17:30 and cleared the queue, still shows offline.” Fact with evidence. Keep it under Done, with the time.
“Tried the usual.” Vague. Cannot be checked. Write UNKNOWN and ask the evening technician before repeating steps.
“Vendor said they’d call back maybe tomorrow?” Unconfirmed. No case number. Write UNKNOWN; the next action checks for one by 10:00 and opens one if missing.
“Might be the same thing as the mailbox issue last week.” Speculation. Keep the tickets separate. Write UNKNOWN; do not link or merge them.
“Admin login for the print server is in my notes.” Unsafe. Remove it. Point to the approved password-manager entry and tell the service coordinator.
“Someone should check it in the morning.” No owner. Assign a role and a check time. The 10:00 time is the reviewer’s decision, recorded as a next action, not a fact from the note.

Result: two facts, one vague item, one unconfirmed claim, one speculation, one unsafe item and one task with no owner. Only the two facts carry over unchanged.

3. The reviewed note (after)

TRAIN-0412 handoff, reviewed Wed 08:05 (fictional training scenario)

Status: Open. Front desk printer shows offline.
Done (evening technician, Tue): Restarted the printer at 17:30 and cleared the print queue. It still showed offline afterwards.
Next action: Morning service-desk technician
  1. Asks the evening technician what "tried the usual" covered, before repeating any step.
  2. Checks TRAIN-0412 for a vendor case number by 10:00.
  3. If there is none, opens a vendor case and records the case number in TRAIN-0412.
Owner: Morning service-desk technician until the vendor case is open, then the service coordinator.
Evidence: TRAIN-0412 entry for the 17:30 restart and queue clear. Vendor case number: UNKNOWN.
Unknowns (do not guess):
  - UNKNOWN: what "tried the usual" included. Ask: evening technician.
  - UNKNOWN: whether the vendor opened a case or only promised a call. Ask: evening technician, then check the vendor portal.
  - UNKNOWN: whether last week's mailbox issue is related. Kept as a separate ticket; no link recorded.
Access: Use the approved password-manager entry for the print server. The credential location was removed from this note, and the service coordinator was told a login is kept in personal notes.
Stop if: The fix needs a driver, firmware or print-server configuration change. That needs change approval; hand it to the service coordinator.

4. Readback check

Give a second person only the reviewed note and ask four questions. Expected readback:

What is the next action? Ask the evening technician what “the usual” covered, then check TRAIN-0412 for a vendor case number by 10:00 and open a case if there is none.
Who owns it? The morning service-desk technician; the service coordinator once the vendor case is open.
What is the evidence? The TRAIN-0412 entry for the 17:30 restart and queue clear. The vendor case number is still UNKNOWN.
When do you stop? Before any driver, firmware or print-server configuration change. Hand it to the service coordinator.

Review outcome: Approved for handoff with three UNKNOWN items open. It passes because the gaps are visible and each has a person to ask, not because they are resolved. Mark it not approved if the reader misses an answer. For example, they might say “call the vendor” without the 10:00 check, or suggest using the login from personal notes. Then revise the note and repeat the readback.