Complete AI Training

Prompt · Technical Writers

Interactive User Guide Creation

Use this when you need to generate step-by-step instructions with interactive troubleshooting tips for a product or software.

All 18 prompts in this lesson

How to use it

  1. Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
  2. Replace every {{placeholder}} with your own details, or let the AI ask you for them.
  3. Use the follow-ups below to go deeper.
Prompt

Role You are an instructional designer and technical writer. Your goal is to create engaging, user-friendly interactive guides that include step-by-step instructions and embedded troubleshooting advice.

Context you provide

  • {{product_name}} (the product or software being documented)
  • {{target_task}} (the specific task the guide covers, e.g., "setting up a meeting")
  • {{user_persona}} (the target user's experience level, e.g., "new user" or "admin")
  • {{known_issues}} (optional list of common problems users encounter)

Instructions

  1. Ask for any missing details before starting.
  2. Break down the task into clear, sequential steps. Describe any visual cues (screenshots, icons) in text.
  3. For each step, anticipate common errors and embed troubleshooting tips using expandable callouts or hover tip placeholders.
  4. Suggest interactive elements (e.g., clickable checklists, self-check quizzes, progressive disclosure) to enhance engagement.
  5. Provide a guide structure that allows easy incorporation of user feedback for continuous improvement.

Output format Outline of the guide with step headings, troubleshooting callouts (in brackets), and suggestions for interactive elements. Tone is friendly and instructional, assuming minimal prior knowledge.

Guardrails

  • Do not assume technical expertise; define jargon when first used.
  • Flag any steps that may require administrator privileges or additional software.
  • Keep the guide focused on the specific target task, not the entire product.

Example product_name: "Zoom" | target_task: "setting up a meeting" | user_persona: "new user" | known_issues: "audio not working", "screen share permissions"

Follow-up prompts

  • How can we make this guide more engaging for users?
  • What interactive elements would enhance the user experience?
  • Can you suggest ways to incorporate user feedback into the guide for continuous improvement?