架构文档编写:如何写出好架构文档
【824】架构文档编写:如何写出好架构文档
你有没有这种感觉:
系统很复杂,但文档很少?
代码改了,文档没改?
新来的人看不懂架构?
架构文档就是系统的"使用说明书",写好文档省很多事。
架构文档类型
架构文档体系: ┌──────────────────────────────────────────────────────┐ │ 战略层文档 │ │ - 企业架构文档(TOGAF) │ │ - 技术路线图 │ │ - 技术选型报告 │ ├──────────────────────────────────────────────────────┤ │ 战术层文档 │ │ - 系统架构设计文档(SAD) │ │ - 接口设计文档(API Spec) │ │ - 数据模型设计文档 │ ├──────────────────────────────────────────────────────┤ │ 执行