Visualizing Architecture (1)

Diagramming Tools

• https://www.lucidchart.com/pages/
• https://miro.com/
• https://www.tldraw.com/
• https://www.draw.io/
• https://excalidraw.com/

Diagramming as Code

• D2: https://d2lang.com/
• PlantUML: https://plantuml.com/en/
• https://www.mermaidchart.com/

Diagramming Frameworks and Notations

• C4 Model: https://c4model.com/

Execution

• Establish a ubiquitous language for Architecture & Design Documentation (diagramming, notation, attributes, etc.)
• Bring to all engineers all the artifacts helping them to achieve a well-documented Architecture & Design for its review.
  • Diagramming Tool
  • Notation Standard
  • Document Template
• Follow best practices for architectural visualization:
  • Use multiple views and perspectives (structural, behavioral, deployment, etc.)
  • Maintain consistent level of abstraction within each diagram
  • Include context diagrams to show system boundaries
  • Create component diagrams showing internal structure
  • Document runtime behavior with sequence/activity diagrams
  • Show deployment views for infrastructure architecture
• Apply the “4+1” architectural view model:
  • Logical view (functionality for end users)
  • Process view (runtime behavior)
  • Development view (programmer’s perspective)
  • Physical view (deployment topology)
  • Scenarios (use cases tying views together)
• Follow diagramming best practices:
  • Keep diagrams simple and focused
  • Use consistent notation and symbols
  • Include clear titles and legends
  • Add descriptive annotations where needed
  • Maintain diagram hierarchy (from high-level to detailed views)