In keeping with the old english adage " A Picture Is Worth A Thousand Words", diagramming is the process of explaining the technical details of an architecture using diagrams or pictures. Often, one finds that it is easier to explain with a labelled diagram than getting tied up in the imperfections of the human languages.
In order to be effective with diagramming techniques. one has to value clarity and consistency in the diagrams. What does that mean?
- Symbols and graphical elements must be standardized.
- The reading flow must be standardized as much as possible. For example, all diagrams must be read left to right and top to bottom is one example.
- Diagrams must have numbered labels that helps the reader step through the diagram in numbered sequence. Note that labels must be consistent with the standard flow directions that the team has chosen for themselves.
With these simple techniques, I guarantee that your teams will be operating at efficiencies that are a notch above what one see with teams where diagramming is optional and even if they exist, they are grossly unpredictable and confusing.
In a recent stint with a large NY based financial services company, I has the privilege to participate in strategy discussions on how we orchestrate the move the cloud. Every presentation came with diagrams but there was simply no standard. Almost none of the pictures had labels. The audience had to follow the tiny mouse icon all over the screen to see exactly what the presenter was trying to say. The symbols and graphics followed no standard. Every presentation introduced cognitive load on the audience in terms of non-standard and sub-standard diagrams.
While I was happy that there were diagrams, I think effective teams can do better by embracing a simple standard way of describing through diagrams.
One word on industry standards like ArchiMate, UML etc. These tend to get "heavy" and don't scale very well across roles and skill levels in enterprises. Be judicious in their use. It is ok to come up with a light weight diagramming approach that is standardized within your team, organization, division. In fact, I would recommend that the diagramming be included as part of documentation standards and teams are put though mandatory training to gain familiarity with them.
Simple Web Site Diagram
Here is a diagram of a simple web site
With numbering , it is easy to tell the story
With numbering , it is easy to tell the story
- The customer or user wants to access a web site and uses a browser.
- The request from the browser hits a web server in the DMZ which allows HTTPS traffic.
- The web server invokes the appropriate logic in the application server.
- In order to service the customer's request, the app server calls a database server which contains data pertinent to the user's request.
Popular Authentication Architecture Diagram
working on it...
