Software Architecture as Code Tools by Dr Milan Milanović

Software Architecture As Code Tools - by Dr Milan Milanović #

Excerpt #
An overview of architecture/diagrams as code tools. Structurizr. C4 model. Mermaid.

We’re seeing more and more tools that enable you to create software architecture and other diagrams as code. The main benefit of using this concept is that the majority of the diagrams as code tools can be scripted and integrated into a built pipeline for generating automatic documentation.

The other benefit responsible for the growing use of diagrams as code to create software architecture is that it enables text-based tooling, which most software developers already use.

What are some existing tools for creating such diagrams?

Structurizr

Create multiple diagrams from a single (C4) model. It allows the creating of numerous diagrams from a single model using different tools and programming languages.

[

]( https://substackcdn.com/image/fetch/f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F888cf099-dd0c-43b2-8d29-81d8abe97520_1172x588.png)

Structurizr

For C4 models, you can also use tools such as C4Sharp, a .net library for building diagrams as code.

PlantUML

It is an open-source tool that allows users to create diagrams from a plain text language. With PlantUML, you can make different kinds of UML and non-UML diagrams, too (Sequence, Class, Component, JSON data, Network, Gantt, etc.).

[

]( https://substackcdn.com/image/fetch/f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fb8c9d6b0-6f3f-4261-96f7-5079253df281_675x495.png)

PlantUML

Diagrams

Turn Python code into cloud system architecture diagrams. A new or current system design can also be explained or represented visually. The primary significant providers that Diagrams presently supports include AWS, Azure, GCP, Kubernetes, Alibaba Cloud, Oracle Cloud, etc.

[

]( https://substackcdn.com/image/fetch/f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F235b2242-dfda-428c-874e-2d61aeafa03b_904x617.png)

Diagrams

4. Mermaid

Mermaid is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The primary purpose of Mermaid is to help documentation catch up with development.

[

]( https://substackcdn.com/image/fetch/f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fbc7c28fd-701d-4f43-b53e-29e3d7c3a094_843x830.png)

Mermaid

ASCII editor

ASCII Flow is a simple and easy-to-use online flowchart software that uses ASCII characters to create flowcharts. It allows users to create flowcharts by simply typing the diagram using ASCII characters and then converting it into a visual flowchart. It can create flowcharts, diagrams, and other types of visual diagrams.

[

]( https://substackcdn.com/image/fetch/f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2Fbeabfa71-811b-4579-83ed-7544fe1d05ce_647x383.png)

ASCIIFlow

Markmap

Markmap is a tool that allows you to create and edit mind maps. Markmap uses a technology called Markdown, which is a lightweight markup language, to create and edit mind maps.

[