67
筆記：The Art of Crafting Architectural Diagrams
講如何畫好架構圖，寫的不錯，平時需要寫方案、做架構的人正好可以借鑒一下。
Key Takeaways
Designing architectural diagrams might not be an easy task; it can be tricky or error prone, even for the simplest ones. Creating consistent and meaningful diagrams brings clarity and consensus across different stakeholders.
In most cases, the real issues are not strictly related to using a less efficient Architectural Description Language (e.g. UML), but the misunderstanding of diagrams importance, relying on improper or inconsistent guidelines or even the lack of architectural education.
In the process of creating diagrams, try to blend automatically generated with manually created ones in order to minimize the work, to illustrate different set of concerns and to cover multiple abstraction levels of the system.
As the system is evolving, maintaining diagrams up-to-date requires extra effort. We need to know how to efficiently proceed in such cases by still keeping consistency and robustness across architectural diagrams.
Modern architectures bring extra complexities which are reflected in the diagrams. Additional concerns might emerge and could easily
然後以下圖為例，講了**不好的架構圖的問題**：
以下是以那張圖為例說的架構圖中常見的問題（說實話雖然我一開始看那張圖也覺得有些問題，不過沒有想到他能列這麼多）：
What does a box or shape denote?
What do different edges of a shape represent?
What does a line or an arrow denote?
What is the communication/association type indicated by a line or arrow?
What does that color mean?
Missing relationships between diagram elements or isolated entities
Misleading/undocumented acronyms or too vague/generic terms
Emphasize technologies, frameworks, programming or scripting languages, IDE or development methodology on diagrams
Mix runtime and static elements in the same diagram
Make assumptions like "I will verbally describe this", and "I will explain it later"
Conflicting levels of details or mixed abstractions
Cluttered or too vague diagrams trying to show too much or insufficient level of detail
然後是畫架構圖的建議：
Choose the optimal number of diagrams
Keep structural and semantical consistency across diagrams
Prevent diagrams fragmentation
Keep traceability across diagrams
Add legends next to architectural diagrams
然後是對一些問題的探討：
1，Does the Architectural Description Language (e.g. UML, ArchiMate, etc.) make a difference?這部分感覺沒有說什麼太有用的。
2，How can diagrams be kept up-to-date as the system is developed, and changes to the architecture materialize。
這個他提了三條：
first option, and the easiest one, would be to automatically generate diagrams out of the source code, which is the ground truth.
The second approach would be to first design the diagrams using a dedicated tool which then generate the source code skeletons (e.g. components/packages with boundaries, APIs) used later on by developers to fill in the code.
The last case involves manually updating the diagrams every time a new feature - which has an impact on the architectural design - is implemented.
Taking into account existing tools, my recommendation is to have a mix; to blend automatically and manually create diagrams.
3，What complications (or simplifications) emerge for architectural diagrams when dealing with modern architectures (e.g. microservices)?
這個感覺也米有說太多有用的。
原文鏈接：https://www.infoq.com/articles/crafting-architectural-diagrams
最後更新：2017-08-24 11:33:03