设计文档 注意点

设计文档的要求:

1. 问题梳理:领域问题、技术问题
不重不漏,全景图
2. 充分调研:业内有哪些解决方案,方案对比
不造轮子,借鉴解法
3. 技术选型:结合自己的问题
避免过度设计
4. 设计(达成目标,解决问题)
五视图,端到端思考
架构5图原则

设计文档应该包含的:

1. 项目背景
2. 项目目标
3. 需求分析
4. 方案介绍与对比
5. 数据模型(若有)
6. 详细设计(5图)
6.1 逻辑架构(时序图)
6.2 开发架构(类图)
6.3 运行架构(线程图,参考时序图,讨论性能、安全性、扩展性/可伸缩性、持续可用性)
6.4 物理架构(组件/系统架构图(参与的系统,系统间的依赖))
6.5 数据架构(E-R图,数据库schema(如果是数据库),缓存结构)
7. 开发计划
8. 排期
发布了66 篇原创文章 · 获赞 17 · 访问量 10万+

猜你喜欢

转载自blog.csdn.net/ligeforrent/article/details/80165232