How to create an effective technical architectural diagram?

Click for: original source

An Alibaba engineer shows how you can create effective architectural diagrams. By Ding Yi @Alibaba.

The value of technical communication is not only reflected in the way that applications are developed through commercial products and open-source projects and the way that various business launch processes are accelerated. But, its value is very much also reflected in the experience shared by several different outstanding engineers in improving productivity, optimizing product performance, and promoting the user experience. In a sentence, technical communication is important because it improves our professional capabilities.

The article pays attention to the following:

  • What is an architecture?
  • What is an architectural diagram?
  • What are functions of an architectural diagram?
  • Types of architectural diagrams
    • Scenario view
    • Logical view
    • Physical view
    • Process view
    • Development view
  • What makes for an effective architectural diagram?

… and more. An architecture can be defined as an abstract description of entities in a system and the relationships between them. It involves a series of decision-making processes.

There are many methodologies for depicting a good architectural diagram. This article introduces the C4 method, which however is also constantly evolving. Despite of this, regardless of the drawing methodology, we simply need to consider the intention of the drawing and better communicate it with the audience. We do not have to be unduly restricted by rules in the drawing process. In short, before starting a diagram, ask yourself: Who is it for, what is it of, and how to make it intuitive and understandable. Nice one!

[Read More]

Tags cloud miscellaneous cio software-architecture learning programming