PlantUML Diagram Generator | A Proven AI Prompt for Documentation for engineers | Engify.ai

Prompt Template

Copy the prompt template below

# PlantUML Diagram Generator

## Problem Context

Visualizing system architecture, component relationships, and workflows is essential for documentation, onboarding, and design discussions. PlantUML provides a text-based way to generate professional diagrams that can be version-controlled and easily updated. Many teams struggle to create accurate, up-to-date diagrams that reflect the actual codebase.

## Solution Pattern: Template Pattern

The Template Pattern guides users through diagram creation by asking specific questions about diagram type, scope, and relationships. This ensures the generated diagrams accurately represent the intended system or flow.

## Prompt Template

### Step 1: Determine Diagram Type
Ask: "Which diagram type would you like to generate?
- Component diagram
- Class diagram
- Sequence diagram
- Activity diagram
- Use case diagram"

### Step 2: Scope Definition
Ask: "What is the main functionality or system area you want to visualize?"

### Step 3: Entry Point Identification
- For component diagrams: "What is the main component that initiates the flow?"
- For class diagrams: "What is the primary class/interface?"
- For sequence diagrams: "What triggers this interaction?"
- For activity diagrams: "What starts this process?"
- For use case diagrams: "Who is the primary actor?"

### Step 4: Relationship Depth
Ask: "How many levels of relationships should we include? Choose:
### Step 1: Direct relationships only
### Step 2: Secondary relationships (relationships of related components)
### Step 3: Full dependency chain"

### Step 5: Component Selection
- Analyze codebase from entry point
- List discovered components at chosen depth
- Ask: "I found these components. Select numbers to exclude any that aren't relevant:
### Step 1: [Component A]
### Step 2: [Component B]"

### Step 6: Generate PlantUML
Output:
```plantuml
@startuml
' Theme selection
!theme plain

' Diagram content
[Component definitions]
[Relationship definitions]

@enduml

## Example Use Case

**Scenario**: Documenting a microservices architecture with multiple services and their interactions.

**Process**:
1. Choose diagram type (component diagram)
2. Define scope (order processing system)
3. Identify entry point (API gateway)
4. Set relationship depth (secondary relationships)
5. Select relevant components
6. Generate PlantUML code

**Result**: Professional component diagram showing service relationships, dependencies, and data flow.

---

*This prompt is part of the Engify.ai research-based prompt library. Customize it for your specific context and needs.*

PlantUML Diagram Generator

Unlock Premium Features

Related Prompts

Try These Resources

Related Prompts

Use product strategy red prompt

Use system design review prompt

Use api documentation generator prompt