How to draw beautiful software architecture diagrams (2022)

Re:How to draw beautiful software architecture diagrams (2022) by puchatek on Friday October 27, 2023 @08:46AM (#38037717)

We maintained a c4 model of our systems built for importing and displaying on structurizr.com and tbh, it wasn't fun. You don't get the same intuitive understanding and overview from the code that you get from a diagram and there was no fast local preview. You had to upload your code to the server. Even worse was the fact that adding a new box usually meant realigning all arrows. As a consequence the diagrams were never kept up to date on a continuous basis.

I had a better experience using plantML for sequence diagrams. The task is easier so the output of the interpreter is typically useful without manual interventions.

[ Parent | on HN ]

Re:How to draw beautiful software architecture diagrams (2022) by jk563 on Friday October 27, 2023 @08:53AM (#38037775)

> no fast local preview

I found their Lite container version perfect for local iteration on diagrams: https://docs.structurizr.com/lite/quickstart

[ Parent | on HN ]

Re:How to draw beautiful software architecture diagrams (2022) by ska on Friday October 27, 2023 @01:15PM (#38041171)

FWIW You can do a C4 model using plantUML diagrams [1] imported directly into RST markdown.

That way in an editor like VSCode (e.g. where you have/make plugins to support) you can live preview the diagram in your editor while editing the related text - both get syntax highlighting etc. Using a tool like sphinx to tie everything together helps, as you can easily (enough) write extensions to handle quirks of your own setup reasonable if needed.

I've seen this work pretty well, in a /doc folder in the git repo with some autogenerated reference links as well, from the same repo. You either need the plantUML jar file local (and java, obv) or to point it at a rendering instance "local enough".

[1] https://github.com/plantuml-stdlib/C4-PlantUML

[ Parent | on HN ]