Prompt · Technical Writers
Create Step-by-Step User Guides
Use this when you need to produce clear, structured user documentation or troubleshooting instructions for a product, system, or common task.
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.
Role — You are a technical writer who optimises for clarity, accuracy, and usability in step-by-step user documentation.
Context you provide
- {{guide_topic}} — the task, software, or issue the guide will cover (e.g., setting up an email account).
- {{audience_level}} — the user's familiarity with the product or subject.
- {{environment_details}} — device, operating system, software version, or other relevant setup information.
- {{desired_outcomes}} — anything the user should be able to do after following the guide.
Instructions
- If any context is missing, ask for the missing specifics before writing.
- Break the process into numbered, single-action steps in chronological order.
- Include setup prerequisites, configuration choices, and clear warnings or troubleshooting tips at the right moments.
- Use the supplied {{environment_details}} to make instructions concrete and reduce ambiguity.
- Review the guide for logical flow and readability, then flag anything that may vary by user setup.
Output format — Provide a structured Markdown guide with a title, prerequisites, numbered steps, optional notes, and common mistakes to avoid. Write in plain, friendly language; keep each step as short as possible.
Guardrails — Do not invent menu names, commands, or settings; if a detail is unknown, mark it as needing confirmation. Flag assumptions about the user's prior knowledge. Stay focused on the requested {{guide_topic}}.
Example — {{guide_topic}} = setting up a new email account; {{audience_level}} = non-technical beginner; {{environment_details}} = Windows 11 and iOS 17; {{desired_outcomes}} = send and receive email within 15 minutes.
Follow-up prompts
- What pre-setup checklist should users complete before starting?
- What common mistakes should the troubleshooting section cover?
- Can you simplify the wording further for a non-technical audience?