国内标准GB-软件开发主要文档编写规范

第 3 章软件设计 231 GB 8567－88 软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88 中主要软件文档的 编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说 明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目 开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a．所建议开发的软件系统的名称。 b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文。 b．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、 发表日期和出版单位，说明能够得到这些文件资 料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口 以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频 度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输 之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。 第 3 章软件设计 232 d．管理信息服务的改进。 e. 自动决策系统的改进。 f. 人员利用率的改进。 2.3 条件、假定和限制 说明对这项开发中给出的条件、假定和所受到的限制，如 a. 所建议系统的运行寿命的最小值。 b. 进行系统方案选择比较的时间。 c. 经费、投资方面的来源和限制。 d. 法津和政策方面的限制。 e. 硬件、软件、运行环境和开发环境方面的条件和限制。 f. 可利用的信息和资源。 g. 系统投入使用的最晚时间。 2.4 进行可行性研究的方法 说明这项可行性研究将是如何进行的，所建议的系统将是如何评价的。摘要说明所使用 的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等。 2.5 评价尺度 说明对系统进行评价时所使用的主要尺度．如费用的多少、 各项功能的优先次序、开发 时间的长短及使用中的难易程度。 3 对现有系统的分析 这里的现有系统是指当前实际使用的系统。这个系统可能是计算机系统，也可能是一个 机械系统甚至是一个人工系统。 分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。 3.l 处理流程和数据流程 说明现有系统的基本处理流程和数据流程。此流程可用图表即流程图的形式表示，并加 以叙述。 3.2 工作负荷 列出现有系统所承担的工作及工作量。 3.3 费用开支 列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料 等项开支以及开支总额。 3.4 人员 列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。 3.5 设备 列出现有系统所使用的各种设备。 3.6 局限性 列出本系统的主要的局限性，例如处理时间赶不上需要，响应不及时，数据存储能力 不足。处理功能不够等。并且要说明，为什么对现有系统的改进维护已经不能解决问题。 4 所建议的系统 本章将用来说明所建议系统的目标和要求将如何被满足。 4.l 对所建议系统的说明 概括地说明所建议系统，并说明在第2 节中列出的那些要求将如何得到满 足，说明所使用的基本方法及理论根据。 4.2 处理流程和数据流程 给出所建议系统的处理流程和数据流程 第 3 章软件设计 233 4.3 改进之处 按 2 节中列出的目标，逐项说明所建议系统相对于现存系统具有的改进。 4.4 影响 说明在建立所建议系统时，预期将带来的影响，包括： 4.4.1 对设备的影响 说明新提出的设备要求及对现存系统中尚可使用的设备需作的修改。 4.4.2 对软件的影响 说明为了使现存的应用软件和支持软件能够同所建议系统相适应。而需要对这些软件所 进行的修改和补充。 4.4.3 对用户单位机构的影响 说明为了建立和运行所建议系统，对用户单位机构、 人员的数量和技术水平等方面的全 部要求。 4.4.4 对系统运行过程的影响 说明所建议系统对运行过程的影响，如： a．用户的操作规程。 b. 运行中心的操作规程。 c. 运行中心与用户之间的关系。 d. 源数据的处理。 e. 数据进入系统的过程。 f. 对数据保存的要求，对数据存储、恢复的处理。 g. 输出报告的处理过程、存储媒体和调度方法。 h. 系统失效的后果及恢复的处理办法。 4.4.5 对开发的影响 说明对开发的影响，如： a. 为了支持所建议系统的开发用户需进行的工作。 b. 为了建立一个数据库所要求的数据资源。 c. 为了开发和测验所建议系统而需要的计算机资源。 d. 所涉及的保密与安全问题。 4.4.6 对地点和设施的影响 说明对建筑物改造的要求及对环境设施的要求。 4.4.7 对经费开支的影响 扼要说明为了所建议系统的开发，设计和维持运行而需要的各项经费开支。 4.5 局限性 说明所建议系统尚存在的局限性以及这些问题未能消除的原因。 4.6 技术条件方面的可行性 本节应说明技术条件方面的可行性，如： a．在当前的限制条件下，该系统的功能目标能否达到。 b. 利用现有的技术，该系统的功能能否实现。 c. 对开发人员的数量和质量的要求并说明这些要求能否满足。 d. 在规定的期限内，本系统的开发能否完成。 5 可选择的其他系统方案 扼要说明曾考虑过的每一种可选择的系统方案，包括需开发的和从国内国外直接购买 的，如果没有供选择的系统方案可考虑，则说明这一点。 5.1 可选择的系统方案1 第 3 章软件设计 234 参照第 4 节的提纲说明可选择的系统方案 1 ，并说明它未被选中的理由。 5.2 可选择的系统方案2 按类似 5.1 条的方式说明第2 个乃至第 N个可选择的系统方案。 6投资及效益分析 6.1 支出 对于所选择的方案，说明所需的费用。如果已有一个现存系统，则包括该系统继续运行 期间所需的费用。 6.l.1 基本建设投资 包括采购、开发和安装下列各项所需的费用，如： a. 房屋和设施。 b. ADP 设备。 c. 数据通讯设备。 d. 环境保护设备。 e. 安全与保密设备。 f ．ADP操作系统和应用的软件。 g. 数据库管理软件。 6.1.2 其他一次性支出 包括下列各项所需的费用，如： a. 研究（需求的研究和设计的研究）。 b. 开发计划与测量基准的研究。 c. 数掘库的建立。 d.