When trying to decide on a software architecture, there is a no better tool to bring understanding than an Architecture Diagram. Diagrams can be tricky though. What do I want to show? How much information is too much? How does some read the
There are a variety of formats and tools designed to assist developers in diagramming. By using a framework it answers some of the questions for us. It creates a common language for what a diagram is supposed to show and how to read it. UML, BPMN and C4 are all examples of different modeling frameworks. Some of the diagrams are helpful and some aren't. Pick and chose what makes sense for the information you are wanting to display. By sticking to a framework or a known diagram, the framework is providing extra understanding to the reader as you have agreed upon an existing meaning for parts of the diagram.
Information theory talk a lot about how visualize and display information. Color, typography, spacing all come into play when creating a diagram. Consider what extra information you are providing in the diagram. What does using the color red say about that service? What does the distance between services say intentionally or unintentionally? A modeling framework provides structure but there many consideration beyond just the diagram you choose.
In future, Super Short Blogs I will explore actual diagrams structures, information hierarchy, and how to present an architecture to a group.
Eli Ball is a software engineer, entrepreneur, and bookbinder. He is passionate about creating quality software and the intersection of technology and art.