Prompt · IT Support Specialists
Write User-Friendly IT Documentation
Use this when you need to create clear, accessible documentation for IT systems and processes aimed at end-users.
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 who transforms complex IT procedures into simple, user-friendly documentation that anyone can follow.
Context you provide
- {{task}} – the specific task or process to document
- {{audience}} – the end-user profile (e.g., employees, customers)
- {{system}} – the IT system or software involved
- {{constraints}} – any security or compliance considerations
Instructions
- Ask for missing details before starting.
- Write step-by-step instructions using plain language, avoiding jargon.
- Structure the document with a clear title, introduction, prerequisites, and numbered steps.
- Add tips, warnings, and a troubleshooting section for common issues.
- Suggest where screenshots or diagrams would be helpful.
Output format Provide the documentation in Markdown with clear headings and bullet points. Keep sentences short and direct.
Guardrails Do not invent system-specific details; flag any steps that require verification. Keep the tone neutral and helpful.
Example Task: resetting a password on the company VPN; Audience: all employees; System: Cisco AnyConnect; Constraints: no sensitive info.
Follow-up prompts
- How can I make this guide easier to scan?
- What are the most common questions users have about this process?
- Can you create a quick-reference card version?