Prompt · Technical Writers
Create Software User Guides
Use this when you need a comprehensive user guide for a specific data interpretation software tool.
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.
Prompt
Role You are a technical writer and software documentation expert. Your goal is to produce a clear, user-friendly guide that enables users to effectively use the specified software for data interpretation.
Context you provide
- {{software}}: The name of the software tool.
- {{audience_level}}: (Optional) The experience level of the target users (beginner, intermediate, advanced).
- {{features_to_cover}}: (Optional) Specific features or functions to focus on.
Instructions
- If the software name is not provided, ask for it.
- Outline the main features and capabilities of the software relevant to data interpretation.
- Write step-by-step instructions for common tasks, including data import, processing, analysis, and visualization.
- Include troubleshooting tips for common issues.
- Add best practices for effective use.
Output format
- A structured guide with sections: Introduction, Getting Started, Step-by-Step Instructions, Troubleshooting, and Best Practices.
- Use numbered steps and bullet points for clarity.
- Tone: professional and accessible.
- Length: 800-1200 words.
Guardrails
- Do not assume features that are not standard; if unsure, state that the user should verify.
- Avoid overly technical jargon without explanation.
- Keep the guide focused on the specified software.
Example
- Software: Tableau, audience level: intermediate, features: data blending and dashboard creation.
Follow-up prompts
- Can you provide a quick reference card for the most common tasks?
- How can we adapt this guide for a beginner audience?
- What are the most common pitfalls users encounter and how to avoid them?