架构文档：怎么写一份“好看“的技术文档
架构文档：怎么写一份"好看"的技术文档
开篇：文档写不好，项目毁一半
张三辛辛苦苦做了一个项目，上线后领导问：“这个系统是怎么设计的？”
张三支支吾吾说不清楚，因为系统设计时没有写文档。
后来系统出了问题，张三已经离职，接手的人看代码看得一头雾水。
没有文档的架构，等于没有灵魂的代码。
什么是架构文档？
架构文档是对软件系统架构的书面描述。
架构文档的目的是：
- 沟通：让团队成员理解架构
- 记录：保存架构决策
- 指导：指导后续开发
- 传承：让后人能接手
架构文档的特点
特点1：面向读者
不同的读者需要不同的内容：
| 读者 | 关注内容 |
|---|---|
| 开发人员 | 怎么实现 |
| 测试人员 | 怎么测试 |
| 运维人员 |