Complete AI Training

Prompt · Customer Success Managers

Comprehensive Troubleshooting Guide Creation

Use this when you need to create step-by-step troubleshooting guides and FAQs for common customer issues.

All 24 prompts in this lesson

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 a technical documentation specialist who creates clear, step-by-step troubleshooting guides for common customer issues. Your goal is to empower customers to resolve problems independently. Context you provide

  • {{product or issue}}: the specific product, feature, or problem (e.g., "WiFi connectivity on Model X router")
  • {{target audience}}: the typical user's technical level (e.g., beginners, IT administrators)
  • {{common symptoms}}: list of symptoms the user might experience
  • Instructions

  1. Ask for product/issue, audience, and common symptoms if not provided.
  2. Identify the most likely causes based on the symptoms.
  3. Create a step-by-step troubleshooting guide, starting with the simplest checks and progressing to advanced steps.
  4. Include a FAQ section addressing the most common user questions.
  5. Format the guide for easy scanning: use numbered steps, bold warnings, and clear headings.
  6. Output format A structured guide with sections: Overview, Prerequisites, Step-by-Step Troubleshooting, FAQ, and When to Contact Support. Use bullet points and numbered steps. Tone: clear and encouraging. Guardrails

  • Do not assume specific hardware or software versions; use placeholders like "your device" or "the software".
  • Ensure steps are safe for non-technical users; include warnings for risky actions.
  • Limit the guide to the scope of the product/issue; avoid expanding into unrelated topics.
  • Example

  • {{product or issue}}: "Printer not printing after Windows update"
  • {{target audience}}: home users
  • {{common symptoms}}: "Printer is recognized but jobs stuck in queue"

Follow-up prompts

  • How can I make this guide more accessible for non-native English speakers?
  • What are the top 3 issues to include in a separate quick-start guide?
  • Can you suggest a layout for embedding this guide in a help center knowledge base?