软件详细设计说明书的审查要点
一、形式审查
1、文档格式
是否符合《计算机软件文档编制规范》的格式要求;目录、章节编号是否规范。
2、文档完整性
引言、程序系统结构、各程序设计说明、数据库设计、界面设计等章节是否齐全。
3、版本与日期
编写日期是否在概要设计说明书之后,且与实施方案日期对应;版本号、修订记录是否完整。
4、签字盖章
编制人、审核人、批准人签字是否齐全,日期是否一致。
5、术语一致性
文档中使用的术语是否与需求规格说明书、概要设计说明书保持一致。
二、逻辑性审查
1、设计顺序
详细设计是否基于已评审通过的概要设计说明书展开,层次关系是否清晰。
2、模块分解
模块划分是否合理,模块粒度是否适中,是否存在过度分解或分解不足。
3、层次结构
程序系统结构图是否清晰表达了模块间的层次关系、调用关系和依赖关系。
4、流程逻辑
算法描述、流程图、判定表等是否逻辑清晰,无矛盾、无死循环、无不可达分支。
三、一致性审查
1、与需求的一致性
一级、二级、三级功能设计是否满足需求规格说明书中的功能需求;每个需求项是否都有对应的设计实现。
2、与概要设计的一致性
模块划分、接口定义、数据流向是否与概要设计说明书一致;概要设计中的架构决策是否在详细设计中得到落实。
3、性能指标一致性
响应时间、吞吐量、并发数、资源占用等性能指标是否与需求规格说明书和概要设计一致。
4、安全指标一致性
安全等级、访问控制、加密要求、审计日志等安全设计是否与需求一致。
5、需求可追溯性
每个设计单元是否能追溯到对应的需求条目(可要求承建单位提供需求-设计追溯矩阵)。
四、符合性审查
1、接口设计
模块间接口、外部系统接口的定义是否明确;参数类型、传递方式、返回值、异常处理是否合理、安全、可靠。
2、数据库设计
数据字典是否与需求、概要设计、详细设计一致;表结构、字段类型、索引设计、约束条件是否合理;是否考虑数据安全和备份恢复。
3、算法设计
算法选择是否合理,复杂度是否可接受;关键算法是否有性能分析或复杂度说明。
4、输入输出设计
输入项的有效性校验规则、输出项的格式和范围是否定义完整。
5、异常处理
是否充分考虑了各类异常情况(输入非法、资源不足、网络中断等)的处理机制。
6、测试可行性
设计是否便于单元测试;是否预留了测试接口或桩模块/驱动模块的设计。
7、运行维护可行性
设计是否便于后期运维、故障排查和功能扩展;日志设计是否完善。
8、压力测试考虑
是否对高并发、大数据量等压力场景有相应的设计考虑。
9、设计方法适宜性
是否采用面向对象设计或结构化设计等方法;设计工具和方法是否符合项目约定标准。
五、监理输出文档
审查完成后,监理机构应根据实际情况输出以下文档:
-
详细设计说明书检查表——逐项记录审查结果及问题描述
-
监理意见/评审意见——对详细设计的综合评价,明确通过、修改后通过或不通过
-
监理通知单——对发现的问题和不合格项发出整改通知
-
会议纪要——记录评审会议的过程和结论
-
工程备忘录——记录重要事项和各方约定
夜雨聆风