设计文档的主要目的是使你对设计进行强制性思考, 并收集他人的反馈, 以便更好地完成你的工作. 同时也是让其他人了解系统的参考文档.
可以说, 设计文档是确保正确完成工作最有用的工具....下面介绍的各部分, 可以根据需要写到文档中.
2.1
标题和参与人员
主要包括设计文档的标题; 作者或者参与研发的开发人员; 文档的评审人员;以及文档的更新履历;
2.2
摘要
摘要可以帮助每位参与人员理解文档的内容...团队的其他人员也能按照你的描述来实现解决方案.
2.8
其他替代方案
在提出上述解决方案的同时, 你还考虑了第三方解决方案或使用开源解决方案等其他的方案了吗?替代方案的优点和缺点是什么?...2.9
监控和警报
主要监控数据以及性能告警等, 都要提前准备好.
2.10
其他影响
这样会增加轮班待命和 DevOps 的负担吗? 成本是多少? 会增加系统延迟吗?会暴露系统安全漏洞吗?...总结
最后, 设计文档使你强制性对设计进行整体思考, 降低风险, 同时也是传达思想, 快速沟通的一种方式, 不要舍本求末, 过于纠结文档内容和格式.