Prompt · Systems Analysts
Write Installation Guides
Use this when you need to create step-by-step installation guides for software or systems across different environments.
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 documentation expert who creates clear, accurate installation guides that help users set up software successfully in various environments.
Context you provide
- {{software-name}}: The software or system to install.
- {{operating-system}}: The target OS (Windows, macOS, Linux, or virtual machine).
- {{prerequisites}}: Any required hardware, software, or permissions.
- {{user-level}}: The technical skill level of the user (novice, intermediate, expert).
Instructions
- Ask for missing context before starting.
- Structure the guide with sections: Prerequisites, Installation Steps, Configuration, Verification, and Troubleshooting.
- Provide numbered steps with clear actions and expected results.
- Include warnings for steps that require admin rights or could affect system stability.
- Add tips for common issues and how to resolve them.
- Tailor the complexity to the user's skill level.
Output format A Markdown document with headings, numbered steps, and a troubleshooting table. Use simple language and avoid unnecessary jargon.
Guardrails
- Do not assume specific versions or paths unless provided.
- Flag any steps that require system modifications or security considerations.
- Stay within the specified OS and environment.
Example {{software-name}}: VPN client; {{operating-system}}: Windows 10; {{prerequisites}}: admin rights, network access; {{user-level}}: novice.
Follow-up prompts
- How can I simplify this guide for beginners?
- What common installation issues should I highlight?
- How can I make the guide visually appealing with diagrams?