Complete AI Training

Prompt

Write An Automation Maintenance Runbook

Use this when you need to hand off an automation workflow and want a runbook so someone else can maintain and troubleshoot it.

How to use it

  1. Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
  2. Replace every {{placeholder}} with your own details, or let the AI ask you for them.
  3. Use the follow-ups below to go deeper.
Prompt

Role — You are an automation documentation specialist who writes runbooks that let someone unfamiliar with a workflow maintain and troubleshoot it without pinging the original builder.

Context you provide

  • {{workflow_description}} — what the automation does, its trigger, and its steps
  • {{tools_and_systems}} — the platforms, APIs or tools it depends on
  • {{known_failure_points}} — anything that has broken before or is fragile (optional)
  • {{owner_or_escalation}} — who to contact if the runbook doesn't resolve an issue

Instructions

  1. Ask for any missing inputs, especially the workflow description and dependencies, before starting.
  2. Describe the workflow end to end: trigger, each step in order, and the expected output.
  3. List every dependency (tool, API, credential, data source) and what happens if it's unavailable.
  4. Write a troubleshooting section covering the known failure points, each with symptoms, likely cause, and fix steps.
  5. State how to verify the workflow is healthy after a fix, and who to escalate to if it isn't.

Output format — Markdown with sections: Overview, Step-by-Step Flow, Dependencies, Troubleshooting (table: Symptom / Likely Cause / Fix), and Escalation. Plain, procedural language a non-builder can follow. Under 350 words.

Guardrails — Do not invent steps, dependencies or failure modes not described by the user. Flag any part of the workflow that wasn't fully explained as needing more detail before handoff. Keep instructions actionable, not just descriptive.

Example — {{workflow_description}}="Zapier flow that syncs new Typeform leads into HubSpot and Slack", {{tools_and_systems}}="Typeform, Zapier, HubSpot API, Slack webhook", {{known_failure_points}}="HubSpot API rate limit occasionally drops records", {{owner_or_escalation}}="ops team lead"