作者:黄鑫(glacier②unnoo.com)
软件质量管理的目标是通过日常工作在开发过程之中内建质量而非修补质量,所以在提出了针对设计文档和代码质量的明确要求后,就应该在文档、代码的定期审核过程中检查提出的要求是否被正确实施,而不是在发现错误无法定位或产品难于维护时才开始纠正。设计文档和代码的审核通常由SQA部门或项目负责人完成,但对于较简单的模块代码,也可以采用开发人员之间交叉评审的放式,以减轻项目负责人的负担。
下面列出的检查内容只是我根据自己可预见的问题整理所得,还需要在实际开发工作中进一步完善。
设计文档检查内容
文档主结构——文档结构是否符合国标或内部要求,文档内容是否完整。
设计合理性——接口部分设计以及参数、返回值是否合理。
容错设计——整体结构或模块结构中是否有足够的容错设计,不会因为某项非致命错误而导致不可恢复的数据损失。
错误处理——是否使用统一的错误处理函数和统一的错误代码,不会在错误发生时无法定位错误模块和获得错误代码。
文档可读性——文档内容描述是否足够清晰,复杂描述部分是否配有相应的图表。
上下层一致性——文档描述与对应的上层设计或原型代码是否一致。
术语一致性——各文档中使用术语是否与《术语字典》中术语对应。
文字缺陷——描述中是否存在歧义或错别字。
示例:略
程序代码检查内容
代码编写风格——是否遵守《代码编写规范》。
代码可读性——代码结构是否清晰、易于理解,变量或函数命名是否存在歧义。
注释风格——主要函数的输入、输出项及返回值是否有详细说明,函数内主要分支是否有相应说明。
与设计文档一致性——代码实现与设计文档是否一致。
代码健壮性——对各个函数或系统API调用失败后是否有足够的错误处理,不会引起非法操作;对传入参数及指针变量的检查是否充分,对临时申请的系统资源是否及时回收。
示例:略