文件编制实施指南(D).docVIP

文件编制实施指南 目的 为了控制文件编制中的灵活性，保证文件编制能达到应该达到的目的，指导在一个具体的软件开发任务中，应编制的文件种类及文件的详细程度。因国内目前还没有成熟的经验，现以国外经验制定如下方法供在工作中参考。 规定 具体需要编制哪些文档，可根据实际情况确定，但至少要包括客户提出的、必须提供给客户的手册、及考虑到本单位以后有参考价值的文档（保证以后软件维护的需要）。 在软件开发之前，应该确定该项目中需要编制哪些文档，由项目组组长与主要成员共同讨论，最后由组长确定，并具体落实什么文档由谁负责。 在《项目开发计划书》中要写明必须编制的文档。 方法一 此方法用求和法确定应编制的文件。方法要点是提出十二个考虑因素来衡量一个应用软件，每个因素可能取值的范围是1至5。项目负责人可用这十二个因素对所要开发的程序进行衡量，确定每个因素的值。把这十二个因素的值相加，得到一个总和，然后由这个总和的值来确定应该编制的文件的种类。具体过程如下： 按表一中的十二个因素衡量所要开发的程序，得到每个因素的值； 把衡量所得的各个因素的值相加，得总和之值； 根据总和之值，从表二查出应编制的文件种类。 表一 文件编制的十二项衡量因素 序号 因素 因素取值准则 1 2 3 4 5 1 创造性要求 没有-在不同设备上重编程序 很少-具有更严格的要求 有限-具有新的接口 相当多-应用现有的技巧 重大的-应用先进的技巧 2 通用程度 很强的限制-单一目标 有限制-功能的范围是参量化 有限的灵活性允许格式上有某些变化 多用途、灵活的格式有一个主题领域 很灵活-能在不同的设备上处理范围广泛的主题 3 工作范围 局部单位 分指挥部 单个指挥部 多个指挥部 国防部、世界范围 4 目标范围的变化 没有 极少 偶尔有 经常 不断 5 设备复杂性 单机、常规处理 单机、常规处理，扩充的外设系统 多机、标准外设系统 多机、复杂的外设系统 主机控制系统，多机、自动I/O和显示 6 人员 1～2人 3～5人 5～10人 10～18人 18人以上 7 开发投资 6人月以下 6人月至3人年 3人年至10人年 10人年至30人年 30人年以上 8 重要程度 数据处理 常规过程控制 人身安全 单位成败 国家安危 9 对程序改变的完成时间要求 2周以上 1～2周 3～7天 1～3天 24小时之内 10 对数据输入的响应时间要求 2周以上 1～2周 1～7天 1～24小时 60分钟之内 11 程序语言 高级语言 高级语言带一些汇编 高级语言带相当多汇编 汇编语言 机器语言 12 并行的软件开发 没有 有限 中等程度 很多 完全的并行开发 表二 各项因素总和同文件编制要求的关系 因 素 总 和 可行性研究报告 项目开发计划 软件需求说明书 数据要求说明书 概要设计说明书 详细设计说明书 数据库设计说明书 用户手册或使用说明 操作手册 模块开发卷宗 测试计划 测试分析报告 项目开发总结报告 项目进度月报 12～18* √ √ √ 16～26 √ √ *** *** √ √ √ ** √ √ 24～38 √ √ √ *** *** √ √ √ √ ** √ √ 36～50 √ √ √ *** √ *** √ √ √ √ √ √ √ 48～60 √ √ √ *** √ √ *** √ √ √ √ √ √ √ 注： * 在因素总和较低的情况下，项目开发总结报告的内容应包括：程序主要功能、基本流程、测试结果和使用说明。 ** 测试分析报告应该写，但不必很正规。 *** 数据要求说明书和数据库设计说明书是否需要编写应该根据所开发的软件的实际需要来决定。 方法二 此方法的出发点是：把对软件文件的编制要求同软件的规模大小联系起来。先把软件的规模分为如下四种： 小规模软件 源程序行数小于5000的软件； 中规模软件 源程序行数为10000——50000的软件； 大规模软件 源程序行数为100000——500000的软件； 特大规模软件 源程序行数大于500000的软件。 对上述四种软件的文件编制要求分别列于表三。 表三 产品文件体系 小规模软件 中规模软件 大规模软件 特大规模软件 软件要求和开发计划 软件设计说明 使用说明 测试分析报告 项目开发总结 项目开发计划 软件需求说明 测试计划 软件设计说明 使用说明 模块开发卷宗 测试分析报告 开发进度月报 项目开发总结 可行性研究报告 项目开发计划 软件需求说明 数据要求说明 测试计划 概要设计说明 细设计说明 数据库设计说明 用户手册 操作手册 模块开发卷宗 测试分析报告 开发进度月报 项目开