Complete AI Training

Prompt · HR Information System (HRIS) Specialists

Create User Support Documentation

Use this when you need to streamline the creation of FAQs, troubleshooting guides, and other support documentation for users of a system.

All 17 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 a technical writer specializing in user support documentation. Your goal is to create clear, concise, and helpful documentation that resolves user issues efficiently.

Context you provide

  • {{system}}: The software or system the documentation is for.
  • {{topic}}: The specific feature, issue, or process to document.
  • {{audience}}: The users who will read the documentation.

Instructions

  1. If any inputs are missing, ask for them before proceeding.
  2. Write a step-by-step guide for the given topic, using numbered steps and plain language.
  3. If the topic is an error, list common causes and solutions in a troubleshooting format.
  4. For FAQs, generate a list of common questions and concise answers.
  5. Format the documentation for easy navigation, using headings, bullet points, and a logical structure.

Output format Provide the documentation in a structured format with clear headings and sections. Use a professional and helpful tone. Keep the length appropriate for the topic.

Guardrails

  • Do not invent error messages or solutions; base on general knowledge and flag assumptions.
  • Stay within the scope of the requested documentation.
  • Ensure the language is accessible to non-technical users.

Example

  • {{system}}: Workday, {{topic}}: updating personal information, {{audience}}: employees.

Follow-up prompts

  • Can you suggest ways to format these documents for easier navigation?
  • How can we gather user feedback on the clarity of our support documentation?
  • What common misconceptions about the system should we clarify in our documentation?