20. CRAFT Prompt for Troubleshooting Guide Development

Context: I need to create a comprehensive troubleshooting guide for [specific product/service name and version] used by [customer types/user segments]. This product/service commonly experiences [known issues/failure points/user challenges] that generate [volume of support requests/customer frustration]. Users typically have [technical expertise level] and attempt troubleshooting in [environment/conditions]. Current support resources are [inadequate/outdated/too technical/too basic] resulting in [unnecessary escalations/extended downtime/customer dissatisfaction]. This guide will be used by [end users/support staff/field technicians] to diagnose and resolve issues independently when possible.

Role: Act as a Technical Documentation Specialist with expertise in diagnostic processes and user-centered instruction. You understand how to structure logical troubleshooting flows, can anticipate common user errors and misconceptions, and know how to create clear guidance that builds confidence through progressive problem resolution.

Attributes + Actions:

• Methodical in creating logical diagnostic paths

• Clear and precise in instruction language

• Empathetic to user frustration during technical problems

• Comprehensive in covering common scenarios without overwhelming detail

• Actions:

1. Analyze common issues to identify root causes and symptoms

2. Develop diagnostic decision trees for effective problem isolation

3. Create step-by-step resolution procedures with appropriate detail

4. Anticipate potential troubleshooting mistakes and dead ends

5. Include verification steps to confirm successful resolution

6. Structure information for both linear and reference use

7. Incorporate appropriate visual aids to clarify complex steps

Facts & Figures + Functions:

• Common issues: [specific problems with frequency and impact]

• Technical specifications: [relevant product/service details]

• Support data: [common user errors/misconceptions/challenges]

• Environmental factors: [usage conditions/system requirements/dependencies]

• Functions:

1. Create issue categorization framework for logical organization

2. Develop symptom-to-cause mapping matrices

3. Design decision tree diagnostics for complex problems

4. Structure resolution procedures with appropriate detail levels

5. Create visual troubleshooting aids (screenshots, diagrams, etc.)

6. Develop escalation guidelines for unresolved issues

7. Build verification mechanisms to confirm resolution

Target Outcome: A comprehensive troubleshooting guide that includes:

1. Quick reference for common issues and immediate solutions

2. Structured issue categories with symptom identification

3. Step-by-step diagnostic procedures for problem isolation

4. Clear resolution instructions with appropriate detail level

5. Visual aids for complex procedures or identification

6. Verification steps to confirm successful resolution

7. Escalation pathways when self-troubleshooting fails

8. Preventative measures to avoid recurring issues

9. Glossary of technical terms and error messages

The guide should balance thoroughness with usability, maintain a supportive tone that acknowledges user frustration, use consistent terminology throughout, provide clear success indicators for each step, and create confidence through logical progression from problem identification to resolution.