【精选】程序员开发手册(XXXXX项目).docVIP

文档编号： 密 级：机密 XX系统 程序员开发手册 编制: 日期: 审核: 日期: 批准: 日期: 版本: 控制状态: 华迪计算机有限公司 修订记录 第N次变更 版本号 修订简要(章节、原因) 修订人 /日期 批准人 /日期 目 录 1 引言 1 1.1 目的 1 1.2 范围 1 1.3 定义、缩略语和约定 1 1.4 引用文档 1 2 模块开发情况表 1 3 功能说明 2 4 设计说明 2 5 测试说明 2 6 复审的结论 2 引言 目的 〈描述本文件的目的；系统或子系统名称、版本号及简要说明。〉 范围 〈各模块的简要介绍。预期的读者和使用者。〉 定义、缩略语和约定 〈列出本文档中用到的专门术语定义和外文首字母组词的原词组；列出文件编制的基本约定，如，文件格式，字体，重要提示等。〉 引用文档 〈列出本文档引用的所有文档的编号、标题、修订版本和日期。〉 模块开发情况表 模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。 表1 模块开发情况表 模块标识符 模块的描述性名称 代码设计 计划开始日期 实际开始日期 计划完成日期 实际完成日期 单元测试 计划开始日期 实际开始日期 计划完成日期 实际完成日期 组装测试 计划开始日期 实际开始日期 计划完成日期 实际完成日期 代码复交日期/签字 源代码行数 预计 实际 目标模块大小 预计 实际 项目负责人批准日期/签字 功能说明 扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录，同时列出在软件需求说明书中对这些功能进行说明的章、条、款。 设计说明 说明本模块（或本组模块）的设计考虑，包括： ――在系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口； ――在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等； 在编制目前已通过全部测试的源代码时实际使用的设计考虑。 测试说明 说明直接要经过本模块（或本组模块）的每一项测试，包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。 复审的结论 把实际测试的结果，同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较并给出结论。