查看原文

这份模板给出了软件架构文档的基本框架。

• 一般从 introduction 说起，把设计目标，设计的范围说清楚
• 然后把系统约束说清楚，有什么会制约当前的设计，未来会怎么改进
• 从经典的四视图切入系统设计：Use-Case View，Logical View，Process View，Deployment View。
  • Use-Case: 说一些用例，这些用例最好能覆盖到所有的组件；这个视图能把各个视图串在一起
  • Logical：软件如何在逻辑上分层，这一层还不考虑物理的分布
  • Process：比较物理了，可以谈到进程，线程，节点，集群，或者时下比较流行的 Pod 等等。
  • Deployment：如何部署应用，一般现在做 CI，CD 这块有很多现成的工具。
• 最后把可能的安全，性能等边角问题说清楚。