Support Runbook

Knowledge Base Article

Develop a searchable support article that resolves one verified customer problem with safe steps, limits, and escalation guidance.

Try this Runbook

Goal

Create a ready-to-review knowledge base article that helps the intended customer complete one task or resolve one known problem without relying on internal context.

Success Criteria

  • The title and opening match the words and outcome customers seek.
  • Prerequisites, steps, expected results, and recovery paths are explicit.
  • Product behavior and policy claims use verified source material.
  • Metadata, ownership, related content, and review timing are included.

Inputs

  • Customer problem, task, or repeated ticket theme
  • Verified product behavior and supported steps
  • Intended audience, plan, role, device, or version
  • Screenshots or interface labels, if needed
  • Known errors, exceptions, and escalation paths
  • Voice, metadata, localization, and review requirements

Constraints

  • Do not invent interface labels, settings, causes, fixes, or policy.
  • Do not expose internal-only tools, customer data, secrets, or unsafe workarounds.
  • Keep one primary customer outcome per article.
  • Mark version-specific or unverified behavior clearly.

Instructions

  1. Define the customer’s problem, desired outcome, audience, and prerequisite state.
  2. Choose the clearest article type: task, troubleshooting, reference, or explanation.
  3. Draft a searchable title and a brief overview of who the article helps.
  4. Write numbered steps with exact actions and expected results.
  5. Add decision points, common errors, recovery steps, and escalation criteria.
  6. Add related articles, category, tags, owner, and review date.
  7. Flag every fact or screenshot that still requires product verification.

Output

  • Article title and overview
  • Prerequisites
  • Step-by-step article body
  • Troubleshooting and escalation section
  • Related-content suggestions
  • Metadata and review owner
  • Verification gaps

Quality Check

Walk through the article as the target customer, confirm each step against supplied evidence, remove internal jargon, and verify that failure paths do not leave the reader stranded.

Stop Rules

Stop when the product behavior or approved policy cannot be verified. Do not publish, change customer data, or recommend unsafe account, security, payment, or privacy workarounds.

From procedure to operation

Put this Runbook into a controlled workflow.

Learn how an SOP becomes a Runbook, choosemeaningful review points, thencompare plans and capacity.

Ready to handoff busywork?

Start my free trial