Skip to content

Architecture Diagramming

Architecture Diagramming

When designing or modifying a system; you should have an applicable C4 diagram. Additionally, if you're attempting to model a difficult to follow sequence, favor a sequence diagram in addition to the C4 diagram.

Since we have not aquired a specific C4 modeling tool, there you can use from a few. This is not an exhaustive list.

  1. Lucidchart
  2. Draw.io
  3. Visio
  4. Miro
  5. Mermaid
  6. PlantUML

C4 Diagrams

Ensure to store the original file from the application used within the appropriate directory for your project. You do not want to have to recreate the entirety of the diagram for a single change.

If you are exporting the diagram for presentation or documentation purposes, ensure to export it in either an SVG, or a high resolution PNG if unavailable.

All C4's should at a minimum have the appropriate L1 (System) and L2 (Containers) diagrams, and should contain lower if applicable.

If you are unfamiliar with the C4 modeling or diagramming, refer to the C4 model website which has a nice breakdown of the layers.

Changes for L1 and L2 should be done before you begin working on the proposed change.

Changes for L3 and L4 is more program specific and it is recommended to revist these as often as permitted.

Date and/or version the diagrams.

Sequence Diagrams

Ensure to store the original file from the application used within the appropriate directory for your project. You do not want to have to recreate the entirety of the diagram for a single change.

If you are exporting the diagram for presentation or documentation purposes, ensure to export it in either an SVG, or a high resolution PNG if unavailable.

Reuse the names from your C4 diagrams so that it is easier to reference the system while looking at the sequence.

Back to top