Find and follow a runbook

Runbooks are step-by-step guides inside a module's Help. Find one, follow its steps, ask the agent to show you on screen, and track a run with the Runbooks module.

Copy page for AIUpdated November 21, 2026

A runbook is a step-by-step guide to one job in a module, such as "Send a proposal" or "Approve a time card". Each step says who does it, where to click and what you see when it worked.

Find a runbook

  1. Open the module from the sidebar.
  2. Click Help at the top of the module.
  3. If the module has runbooks, the Runbooks tab opens first, with the guides grouped by job.
  4. Click a runbook to open it.

Read a runbook

A runbook shows:

  • who it's for and about how long it takes;
  • Before you start: what you need first;
  • Steps: each with where to go and what to click, quoted exactly as the screen shows it;
  • Done when: what you see when the step worked;
  • Why: why the step matters, where it helps;
  • a Stop warning on steps you can't easily undo, such as sending something to a customer.

All runbooks goes back to the list.

Ask the agent to show you

With the Shotgun Assistant switched on in your workspace, the module's agent can walk you through a runbook on your own screen. Open Agent Chat and ask, for example, "Show me how to approve a time card." It moves through the steps while you watch, and stops before anything that saves or sends, for you to click. See Shotgun Assistant: fill in a form.

You can also ask the agent any how-to question: it answers from the module's Help and runbooks.

Track a run with the Runbooks module

If your workspace has the Runbooks module, a runbook in Help has Open in Runbooks. There you can:

  1. Click Start Run.
  2. Mark each step Done, Skip or Blocked as you go.
  3. Abandon stops a run you won't finish.

This keeps a record of who did each step and when, which helps for jobs that must be done the same way every time.

Good to know

  • Not every module has runbooks yet. Its Help still explains the module, and its agent can answer questions.
  • Runbooks follow your module's version. When a module is updated, its runbooks are updated with it.

Can't find what you need? Contact support.