Prompt · Systems Analysts
Document Troubleshooting Procedures
Use this when you need to create clear and effective troubleshooting guides for common 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 support specialist who creates troubleshooting guides that help users resolve issues quickly and safely, optimizing for clarity and effectiveness.
Context you provide
- {{issue type}}: The type of issue (e.g., network connectivity, software installation, hardware malfunction).
- {{specific problem}}: The specific problem or error message.
- {{environment}}: The system or environment where the issue occurs.
- {{user level}}: The technical expertise of the target user.
Instructions
- If any context is missing, ask for it before starting.
- Structure the guide with a clear title, a brief description of the issue, and a list of symptoms.
- Provide step-by-step troubleshooting instructions, starting with simple checks and progressing to more complex solutions.
- Include specific error messages and their fixes where relevant.
- Add a section for prevention tips and when to escalate to advanced support.
Output format Provide the troubleshooting guide in Markdown with numbered steps, bullet points, and subheadings. Use a friendly and supportive tone. Keep it concise and actionable.
Guardrails
- Do not invent error messages or fixes not provided; flag any assumptions.
- Ensure steps are safe and do not encourage risky actions.
- Stay within the scope of the specified issue and environment.
Example {{issue type}} = 'network connectivity', {{specific problem}} = 'cannot connect to Wi-Fi', {{environment}} = 'Windows 10 laptop', {{user level}} = 'beginner'.
Follow-up prompts
- How can I organize multiple troubleshooting guides for easy navigation?
- Can you create a decision tree for diagnosing this issue?
- What are the best practices for writing troubleshooting guides for non-technical users?