写好文档
基本原则
- 从读者视角写
- 避免不必要的重复
- 避免歧义
- 文档结构要标准，有组织性
- 表达理由
- 保持文档最新，但不频繁更新它
- 通过和实际需求结合来检查文档写的好不好（检查文档是否满足需求）
从读者视角
读者的目的是: 更方便地收获信息 并感受到你的努力和认真
因此需要仔细解释一些专业性名词
避免非必要的重复
精确地记录任何信息，避免非必要重复 伴随略微不同的重复会使读者疑惑哪一段信息是正确的
避免歧义
精准表达信息，必要时给出 dictionary 精确解释
图表语言需要准备图例
文档结构要标准，有组织性
记录原因
什么导致了这些决定
原因产生影响
保持文档最新，但不频繁更新它
通过和实际需求结合来检查文档写的好不好（检查文档是否满足需求）
信息是否最好？ 谁是文档的读者？ 写文档的目的？
架构图的哲理
架构描述基于一个或多个视点
每个视点包括一 张或多张视图
一张视图由一个或多个模型组成，只关注一个视点
4+1 view model
逻辑视图：表达行为，关键是对类的抽象
- 类图
- 对象图
- 状态图
- 通信图
- 序列图
过程视图：表达同步性和分布，对象间的地图线
- 活动图
开发视图：组织软件模块，库，子系统，开发单元
- 包装图
- 组件图
物理视图：将其他元素映射成计算节点和沟通节点
- 依赖图 使用例视图（也被称为场景）：将架构映射为重要的使用例
- 用例图
五张视图结合将反映整个系统软件架构的内容