软件文档审查的基本要求

软件文档审查的基本要求作者：杨万君 伍滨来源：中国军转民 2013年第2期杨万君 伍滨软件文档不仅是传统意义上的产品图样资料，文档本身也是软件产品的组成部分。在软件 测试和设计定型中，对软件文档的审查是非常重要的环节，做好软件文档审查，可以有效促进 软件质量提高。下面笔者结合自身工作经验，就如何做好软件文档审查作一简单探讨。一、对文档审查的基本要求对软件文档审查的基本要求，主要从软件文档的完整性、一致性、准确性三个方面来进行（一）完整性主要审查：封面完整性、目录完整性、签署页完整性、正文完整性、附录完整性。（二）一致性主要审查：是否有互相矛盾的两条语句；给定的术语、符号、计量单位、简称或缩略语是 否统一；与上级文档或下级文档中是否有互相矛盾的语句；是否有简称和缩略语在首次使用时 其前面均使用全称；是否所有的表、图，均已在之前的正文中按出现顺序引用过。（三）准确性主要审查：文档内容的语言表述是否清晰、准确、便于理解；封面格式规范性；目录格式 规范性；图格式规范性；表格式规范性；正文格式规范性；标题格式规范性；注释格式规范性二、对需求文档的审查软件需求规格说明文档是软件开发的总领文件，规定了软件的开发最终目标，加强软件需 求规格说明文档的审查，有助于帮助纠正软件开发偏差。主要审查：软件标识、软件名称、软件简称、软件版本号是否正确；指明CSCI必须运行 的环境的需求，包括软件支撑环境需求、硬件支撑环境需求和计算机通信需求；说明需求的优 先次序和关键程序；功能需求的追踪性是否正确；性能需求的追踪是否正确。三、对设计文档的审查软件设计文档忠实记录了软件开发过程，通过对设计文档的审查，可以及时发现开发过程 的问题并加以纠正。（一）范围主要审查：软件标识、软件名称、软件简称、软件版本号是否正确；系统概述是否完整、 准确；文档概述是否完整、准确。二）引用文档主要审查：引用文档齐全、要素完整、正确。（三）设计决策主要审查：给出CSCI输入输出设计决策，包括输入/输出数据流图、输入/输出说明和 行为设计决策；给出CSCI数据库/数据文件设计决策；给出安全性/保密性决策。（四）CSCI体系结构设计主要审查：给出软件配置项部件图；描述构成CSCI的所有部件，并赋予每一个部件一个 项目唯一标识符；描述每一个软件单元的用途并标识分配给它的CSCI需求和CSCI级设计决策; 给出软件配置项类图；如存在的话，画出CSCI设计中的所有活动图并配以文字说明；如存在的 话，画出CSCI设计中的所有交互图并配以文字说明；如存在的话，画出CSCI设计中的所有状 态图并配以文字说明；进行外部接口分析和描述，并对外部接口进行项目唯一标识；对每个外 部接口进行通信特性分析（可选）；分析每个外部接口的协议特性（可选）；外部接口实体将 提供、存储、发送、访问、接收的。四、对使用文档的审查使用文档对于软件全寿命周期管理具有十分重要的意义，软件产品 能否充分发挥使用效能，必须重视使用文档的编写和审核。（一）概要描述主要审查：从用户的角度出发，简要描述用户期望的性能特性；描述意外事故及运行的备 用状态及方式；概述与软件作用有关的保密性和私密性要求；提供联系点和应遵循的手续，以 便用户获得帮助和报告在使用软件时遇到的问题。（二）软件入门主要审查：引导帮助首次使用用户熟悉设备；告知用户如何获得口令；告知用户如何添加、 修改、删除口令；告知用户与生成或输出的文档和媒体有关的保密性私密性要求；指导用户进 行软件的安装和设置；描述软件的启动过程及启动中可能出现的问题；描述如何停止或者中断 软件使用以及如何判断是否是正常结束或终止。（三）使用软件指南主要审查：简述事务、菜单、功能及其他处理相互之间的关系；描述软件使用的任何约定； 描述完成处理过程所必须的次序；描述功能、菜单、事务或其他过程：菜单、图标、数据表项、 输入、输出、错误处理、报警、帮助信息以及可能产生影响的接口及其他软件；描述所有不被 用户直接调用的批处理、脱机处理或者后台处理；描述创建和保留备份数据的过程；给出从处 理过程中发生的错误、误动作中重起和恢复的详细步骤；列出完成用户功能时可能发生的所有 错误消息、诊断消息和信息消息；如存在，应概括常用的功能键、控制序列、格式、命令或软 件使用的其它方面；给出典型的业务流程。五、依据的标准最后需要指出的是：GJB 438B-2009对软件开发过程中产生的文档做了具体明确的规定， 承制方可根据开发软件的实际情况和相关要求，确定产生的软件文档种类，对相关文档种类进 行合并、拆分。文档内容编排一般应按照GJB 438B-2009附录推荐的结构和标题进行，如需剪 裁，应注明“本章无内容”或“本条无内容”并说明理由。作者单位总装驻石家庄地区军代室