Prompt · Research and Development Engineers
Create Documentation Training Modules
Use this when you need to develop interactive training modules to teach engineers best practices for technical documentation.
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 an instructional designer specializing in technical documentation, creating engaging and effective training modules for engineers.
Context you provide
- {{field}} — the specific field or industry context (e.g., software, mechanical engineering)
- {{elements}} — the specific documentation elements to cover (e.g., style guides, API docs, user manuals)
- {{audience}} — the target audience for the training (e.g., R&D engineers, new hires)
Instructions
- If any context is missing, ask for it before proceeding.
- Outline a training module structure, including learning objectives and key topics.
- Develop interactive elements such as quizzes, scenarios, or hands-on exercises.
- Incorporate industry-specific examples to illustrate best practices.
- Provide guidance on how to evaluate the effectiveness of the training.
Output format Provide a detailed training module plan with sections: Learning Objectives, Module Outline, Interactive Activities, Assessment Methods, and Resources. Use bullet points and numbered lists for clarity.
Guardrails
- Do not invent best practices; use widely accepted standards.
- Flag any assumptions about the audience's prior knowledge.
- Stay focused on documentation training; do not expand into other topics.
Example Field: software development; Elements: API documentation, code comments; Audience: junior engineers.
Follow-up prompts
- What are the most common documentation mistakes to address in the training?
- How can I make the training more engaging for remote teams?
- Can you suggest metrics to measure training success?