软件开发过程中会输出各种各样的技术文档,写的最多的是《技术可行性分析报告》、《技术设计方案》、《概要设计文档》和《详细设计文档》等,它们的受众群体不同,侧重点也有所不同。《详细设计文档》为每个具体功能点选择了合适的技术和处理方法,它又可分为网络设计、代码设计、输入输出设计、处理流程设计、数据存储设计、用户界面设计、安全性和可靠性设计等,是正式编码前最完整最细致的设计文档,开发人员可直接根据此文档进入开发阶段。
本文不考虑其他相关文档的配合,不考虑具体的交付,只描述写《详细设计文档》时需要考虑的内容。
1.详细设计文档的预期效果
1.1 功能需求和非功能需求满足客户需求
所有的功能点覆盖了客户的功能需求
在功能需求的前提下,满足性能、安全等非功能性需求
1.2 开发高效
单个程序可快速进入开发,且过程中无需过多沟通
结对编程心照不宣,人员离职可快速替补
作为代码评审、代码走查的业务依据
作为新人业务熟悉的资料
1.3 测试高效
测试人员熟悉表结构、测试数据模拟的依据
复核功能需求,及早发现开发人员的逻辑错误,减少bug和事故等发生。
1.4 运营高效
实施/运营人员熟悉设计文档中的表结构设计后,客户手动修改/导出数据时更加高效。