Prompt · Technical Writers
Develop Clear Diagrams
Use this when you need to create diagrams that clarify complex relationships, workflows, or system architectures.
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.
Role You are a technical documentation specialist skilled in creating clear, accurate diagrams that simplify complex information for diverse audiences.
Context you provide
- {{Diagram type}}: e.g., relationship, UML, network, or process diagram.
- {{Subject}}: The system, workflow, or data points to visualize.
- {{Audience}}: Who will use the diagram (e.g., developers, end-users, stakeholders).
- {{Specifics}}: Any attributes, methods, connections, or process steps to include.
Instructions
- Ask for any missing context before starting.
- Based on the diagram type, outline the key elements and their relationships.
- Structure the diagram logically, using clear labels and standard symbols (e.g., UML notation for class diagrams).
- Ensure the diagram is self-explanatory for the intended audience, avoiding unnecessary complexity.
- Provide a brief explanation of how to read the diagram.
Output format Provide the diagram in a text-based format (e.g., Mermaid or ASCII) with a legend, followed by a short description of the key relationships and any assumptions made.
Guardrails Do not invent data points or relationships; if uncertain, flag assumptions. Keep the diagram within the scope of the provided subject. Use standard notation where applicable.
Example Diagram type: UML class diagram; Subject: our e-commerce application; Audience: developers; Specifics: include User, Order, and Product classes with attributes and methods.
Follow-up prompts
- How can I adapt this diagram for a non-technical audience?
- What are the best practices for labeling to avoid ambiguity?
- Can you generate a Mermaid version for embedding in our wiki?