Overview
This prompt aims to guide users in creating effective troubleshooting guides for complex systems, enhancing their problem-solving skills. Technical writers and support teams will benefit from structured, user-friendly documentation that simplifies issue resolution.
Prompt Overview
Purpose: This troubleshooting guide aims to help users resolve common issues with the specified system or application effectively.
Audience: It is designed for users of varying technical expertise, from beginners to advanced users seeking quick solutions.
Distinctive Feature: The guide offers clear, step-by-step diagnostic procedures and multiple solutions for each identified problem.
Outcome: Users will be empowered to troubleshoot issues independently, enhancing their experience with the system or application.
Quick Specs
- Media: Text
- Use case: Content Creation, Enhancement, Expansion & Elaboration
- Industry: Customer Support & Helpdesk, Diagnostics & Laboratory Services, General Business Operations
- Techniques: Role/Persona Prompting, Self-Critique / Reflection, Structured Output
- Models: Claude 3.5 Sonnet, Gemini 2.0 Flash, GPT-4o, Llama 3.1 70B
- Estimated time: 5-10 minutes
- Skill level: Beginner
Variables to Fill
- [SPECIFY THE SYSTEM/APPLICATION] – Specify The System/application
Example Variables Block
- [SPECIFY THE SYSTEM/APPLICATION]: Example Specify The System/application
The Prompt
# CONTEXT:
Adopt the role of an expert technical writer specialized in creating user-friendly troubleshooting guides for complex systems and applications. Your task is to assist the user in developing a comprehensive troubleshooting guide for a specified system or application, focusing on common issues, diagnostic steps, and clear solutions.
# ROLE:
You are an expert technical writer specialized in creating user-friendly troubleshooting guides for complex systems and applications.
# RESPONSE GUIDELINES:
The troubleshooting guide should be well-structured, easy to follow, and enable users to efficiently resolve problems on their own. It should include the following sections:
1. Introduction
– Brief overview of the system/application
– Purpose and scope of the troubleshooting guide
2. Troubleshooting Steps
For each common issue:
– Problem description
– Symptoms
– Diagnostic steps (numbered)
– Solutions (bullet points)
3. Additional Resources
– Links to relevant documentation, forums, or support channels
– Contact information for further assistance
4. Conclusion
– Recap of the troubleshooting guide’s purpose
– Encouragement for users to refer to the guide when encountering issues
# TASK CRITERIA:
– Focus on common issues that users are likely to encounter.
– Provide clear and concise problem descriptions and symptoms.
– Offer step-by-step diagnostic procedures to help users identify the root cause of the issue.
– Include multiple potential solutions for each problem.
– Ensure the guide is accessible to users with varying levels of technical expertise.
– Avoid using overly technical jargon or complex terminology without proper explanations.
# INFORMATION ABOUT ME:
– System/Application: [SPECIFY THE SYSTEM/APPLICATION]
# RESPONSE FORMAT:
The troubleshooting guide should be formatted using markdown, with:
– Clear headings and subheadings
– Numbered lists for diagnostic steps
– Bullet points for solutions
Avoid using XML tags in the response.
Screenshot Examples
How to Use This Prompt
- [SYSTEM_NAME]: Name of the system/application.
- [COMMON_ISSUES]: Frequent problems users encounter.
- [DIAGNOSTIC_STEPS]: Step-by-step procedures for troubleshooting.
- [SOLUTION_OPTIONS]: Various solutions for each issue.
- [ADDITIONAL_RESOURCES]: Links to documentation and support.
- [CONTACT_INFO]: Information for further assistance.
- [USER_LEVEL]: Varying levels of technical expertise.
- [GUIDE_PURPOSE]: Purpose of the troubleshooting guide.
Tips for Best Results
- Identify Common Issues: Start by listing frequent problems users face with the system/application to set the stage for troubleshooting.
- Clear Diagnostic Steps: Provide numbered steps that guide users through identifying the root cause of issues, ensuring they are easy to follow.
- Offer Multiple Solutions: For each problem, present a variety of solutions in bullet points, catering to different user expertise levels.
- Include Additional Resources: Link to relevant documentation and support channels for users seeking further assistance or clarification.
FAQ
- What is the purpose of a troubleshooting guide?
A troubleshooting guide helps users identify and resolve common issues efficiently. - How should I structure the troubleshooting steps?
Each issue should include a description, symptoms, numbered diagnostic steps, and bullet-point solutions. - What additional resources should I include?
Include links to documentation, forums, support channels, and contact information for assistance. - Why is clear language important in troubleshooting guides?
Clear language ensures users of all technical levels can understand and follow the guide easily.
Compliance and Best Practices
- Best Practice: Review AI output for accuracy and relevance before use.
- Privacy: Avoid sharing personal, financial, or confidential data in prompts.
- Platform Policy: Your use of AI tools must comply with their terms and your local laws.
Revision History
- Version 1.0 (December 2025): Initial release.
