Skip to main content

Creating and Editing Runbooks

Updated over a week ago

Creating a new runbook

  1. Navigate to Runbooks in the sidebar

  2. Click "+ New Runbook"

  3. Fill in the metadata:

    • Title (required) — a clear, descriptive name (e.g., "Microsoft 365 Password Reset")

    • Description — optional summary of what the runbook covers

    • Scope — Global (org-wide) or Company (client-specific)

    • Company — if Company scope, select which client

    • Category — optional tag for filtering (e.g., "Authentication", "Networking")

    • Tags — optional keywords for searchability

    • Audience — Agentic, Hybrid, or Human

  4. The editor opens — start writing your procedure

The runbook editor

Runbooks use a rich block editor with real-time collaborative editing. Multiple team members can edit the same runbook simultaneously — you'll see their cursors in real time.

Available content blocks

  • Headings (H1, H2, H3) — structure your runbook into sections

  • Paragraphs — descriptive text and explanations

  • Bullet and numbered lists — step-by-step instructions

  • Checklists — trackable to-do items

  • Tables — structured data, reference info

  • Code blocks — commands, scripts, configuration snippets

  • Callouts — important notes, warnings, tips

  • Mermaid diagrams — flowcharts and decision trees

Quick formatting

Type / anywhere in the editor to open the slash menu for quick block insertion. Use the toolbar for bold, italic, links, and other inline formatting.

AI Copilot

The sidebar AI assistant can help you write content. Ask it to generate sections, suggest troubleshooting steps, or improve existing content. All AI-generated content appears as a draft for you to review before accepting.

Defining required inputs

If your runbook needs specific information before it can run (like a username or device name), define required inputs in the metadata. Each input has:

  • Name — identifier (e.g., user_email)

  • Label — display name (e.g., "User Email Address")

  • Type — string, email, number, select, date, or boolean

  • Required — whether it must be provided

  • Default — optional default value

Saving and auto-save

The editor auto-saves every 30 seconds. You can also click "Save Draft" at any time. Saving creates a draft — to make it available for use, you'll need to submit it for review and get it published.

Images and attachments

You can upload screenshots and diagrams directly into the editor. Supported formats include PNG, JPEG, GIF, and WebP. Images are useful for documenting UI steps or architecture diagrams.

Exporting

Runbooks can be exported as Markdown files for external documentation or backup purposes.

Did this answer your question?