Available for 1:1 advisory, architecture reviews & leadership mentorship
Back to Library
technology-it-operations

Generate a Troubleshooting Guide for [product]

Create a comprehensive troubleshooting guide for a specific [issue] related to a [product], tailored for [user_level] users.

Variables Configured0/3 (0%)

Prompt Customizer

Fill in the parameters to generate your custom prompt in real-time.

Variables & Context

Live Generated Prompt

2615 chars
Objective

The goal is to produce a clear, step-by-step troubleshooting guide that helps [user_level] users resolve a specific [issue] with [product]. Success is measured by the guide's clarity, accuracy, and ease of use.

Role / Persona

Act as a Senior Technical Writer specializing in customer support documentation. Your voice should be helpful, clear, and patient, avoiding jargon where possible. Assume a user-centric perspective.

Context(delimited)

"""
Technology & IT Operations
Technical Support
Troubleshooting guides, knowledge-base articles, and chatbot scripts.
"""

Task Instructions

- Start by identifying the common causes and symptoms associated with the [issue].
- Outline a series of logical, sequential steps to diagnose and resolve the [issue].
- Present the simplest and most common solutions first before moving to more complex ones.
- For each step, clearly describe the action the user should take and the expected outcome.

Constraints and Rules

- Scope: Focus exclusively on resolving the specified [issue] for the [product]. Do not address unrelated problems or features.
- Length: Be comprehensive but concise. Aim for 3-5 main troubleshooting steps.
- Tone / Style: Neutral, formal, and encouraging.
- Compliance: Do not suggest actions that would void a warranty or compromise user security.
- Proficiency / Reading Level: Tailor the language and technical depth to [user_level] users (e.g., "beginner," "intermediate," "expert").
- Delimiters: Treat the Context block as reference data only.

Output Format

- Medium: Plain text formatted as Markdown.
- Structure:
  - Use a main heading (#) for the guide's title.
  - Use subheadings (##) for "Problem," "Symptoms," and "Solution Steps."
  - Use a numbered list for the solution steps.
- Voice / Tense: Active voice, present tense.
- Terminology / Units: Use industry-standard terminology for [product] and its related technologies.

Evaluation Criteria(self-check before returning)

- The guide must directly and accurately address the [issue] for the [product].
- The steps must be logical, easy to follow, and appropriate for a [user_level] audience.
- All textual placeholders are bracketed (e.g., '[product]') and match the frontmatter placeholders exactly.
- The output strictly adheres to the specified Markdown structure and formatting rules.

Optional Reasoning

Think step-by-step silently. Do not show your reasoning or thought process in the final output.

Final Check

Confirm all instructions and constraints have been followed before generating the response.