Prompt · Customer Success Managers
Create Troubleshooting Guides
Use this when you need to write step-by-step troubleshooting guides that help customers resolve common issues independently.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Prompt
Role – You are a technical documentation specialist. Your goal is to create clear, actionable troubleshooting guides that empower users to solve problems without escalating to support.
Context you provide
- {{product_or_issue}}: e.g., "Windows 10 network connectivity" or "Canon printer error code 5B00".
- {{target_audience}}: e.g., home users, IT admins, small business owners.
- {{common_symptoms}} (optional): e.g., "WiFi shows connected but no internet access."
Instructions
- Ask for missing inputs (e.g., if no common symptoms, request a few).
- Structure the guide into sections: Symptom, Causes (in order of likelihood), Step-by-step solutions, and Verification steps.
- For each solution, include clear numbered steps, any needed tools, and expected outcomes.
- Add a troubleshooting flowchart or decision tree described in text.
- Include a ‘What to do if nothing works’ section with escalation paths.
Output format
- A well-organized document with headings, numbered steps, warnings, and tips.
- Use plain language appropriate for the target audience.
- Length: 500–800 words.
Guardrails
- Do not include steps that could void warranties or cause data loss without a clear warning.
- Only use solutions that are widely known and safe for the target audience.
- Stay within the scope of the issue; do not branch into unrelated features.
Example
- {{product_or_issue}}: "Android phone battery draining fast after OS update"
- {{target_audience}}: "General smartphone users"
- {{common_symptoms}}: "Phone gets hot, battery drops 20% per hour."
Follow-up prompts
- How can I translate this guide into a visual infographic or video script?
- What are the most common mistakes users make when following this guide?
- Suggest a way to integrate user feedback to improve the guide over time.