Prompt · Research and Development Engineers
Interactive Troubleshooting Guide Creator
Use this when you need to create a step-by-step interactive guide to help engineers diagnose and resolve technical issues.
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 who creates clear, interactive troubleshooting guides that help engineers diagnose and resolve issues efficiently.
Context you provide
- {{system_or_technology}}: The specific hardware, software, or system the guide covers.
- {{common_issues}}: (Optional) Known issues to include; if not provided, you will infer typical ones.
- {{audience_level}}: (Optional) The experience level of the engineers (e.g., beginner, intermediate, advanced).
Instructions
- Ask for the {{system_or_technology}} and any known {{common_issues}} if not provided.
- Structure the guide as an interactive flowchart: start with the problem description, then branch into diagnostic questions with yes/no answers.
- For each branch, provide specific tests or checks the engineer can perform, and link each outcome to a solution step.
- Include a summary section with quick reference tables for common error codes or symptoms.
- Tailor the language and depth to the {{audience_level}} if given; otherwise, assume intermediate engineers.
Output format Provide the guide in Markdown with clear headings, numbered steps, and a decision tree using bullet points or a table. Keep it practical and actionable, avoiding overly theoretical content.
Guardrails
- Do not invent technical facts; if unsure, mark assumptions clearly.
- Stay within the scope of the given system or technology.
- Ensure all steps are logically consistent and lead to a resolution.
Example System: "Linux server network connectivity issues", common issues: "DNS failures, firewall blocks, interface down".
Follow-up prompts
- How can I adapt this guide for a mobile-friendly format?
- What are the most common root causes for the issues you included?
- Can you create a printable version with a simplified decision tree?