[工学]软件文档写作05-文档写作要求.pptVIP

编号 因 素 因 素 取 值 1 2 3 4 5 1 创新程度 没有－在不同设备上重编程序 有限－只是具有更严格的要求 很多－具有新的接口 大量－应用新的现代开发技术 重大－应用先进的开发和管理技术 2 通用程度 很强的限制－单一项目 有限制－功能的范围是参量化的 有限的灵活性，允许格式上有些变化 多用途、灵活的格式、有主题领域 很灵活－能在不同设备上处理范围广泛的主题 3 应用范围 局部单位(团以下) 本地应用(师级) 行业推广(军级) 全国推广(大军区) 国际项目(全军范围) 4 应用环境的变化 没有 很少 偶尔有 经常 不断 5 设备复杂性 单机、常规处理 单机、常规处理、扩充的外设系统 多机、标准的外设系统 多机、复杂准的外设系统和显示 主机控制系统多机自动I/O 6 参加开发人数 1~2人 3～5人 6～13人 11~18人 19以上 7 开发投资(人月) 6 6~36 36~120 120~360 360 8 重要程度 一般数据处理 常规过程控制 人身安全 单位成败 国家安危 9 完成程序修改的平均时间 2周以上 1～2周 3～7天 1～3天 24小时以内 10 数据I/O平均时间 2周以上 1～2周 1～7天 1～24小时 1小时以内 11 编程语言 高级语言 高级语言带少量的汇编 高级语言带相当多的汇编 汇编语言 机器语言 12 并行软件开发 没有 有限 中等程度 很多 全部 * * 使用求和法的具体过程是： 1. 按前表中的12个因素衡量所要开发的程序，得到每个因素的值。 在该问题中，我们通过分析可以得知各个因素的得分如下： (1) 创新程度 ＝ 1 (7) 开发投资(人月) ＝ 1 (2) 通用程度 ＝ 3 (8) 重要程度 ＝ 1 (3) 应用范围 ＝ 2 (9) 完成程序修改的平均时间 ＝ 3 (4) 应用环境的变化 ＝ 1 (10) 数据I/O平均时间 ＝ 5 (5) 设备复杂性 ＝ 3 (11) 编程语言 ＝ 1 (6) 参加开发人数 ＝ 1 (12) 并行软件开发 ＝ 2 2. 把衡量所得的各个因素的值相加，得总和之值。 在本例中，这个值 ∑ ＝ 24 可行性研究报告 项目开发计划 软件需求说明书 数据要求说明书 概要设计说明书 详细设计说明书 测试计划 用户手册 操作手册 测试分析报告 开发进度月报 项目开发总结 程序维护手册 12～18 √ √ * √ 16～26 √ √ * * √ √ √ √ √ √ 24～38 √ √ √ * * √ √ √ √ √ √ √ 36～50 √ √ √ * * √ √ √ √ √ √ √ √ 48～60 √ √ √ * * √ √ √ √ √ √ √ √ √ * 3. 根据总和之值，从下表中，查出应编制的文档种类。 文档的种类 因素值总和 表中：*，表示此文档应编制，但不必太正规； **，表示应根据所开发软件的实际需要来确定是否需要编制此文档。 现在，可以依据表格，获知本例需要编制的文档种类，总共有10种之多。 * 2. 根据软件规模大小确定应编制的文档 为了避免在软件开发过程中文档编制的不足或过分，也为了避免前一种方法中对某些因素的把握出现误判，一个简便的方法是，把对软件文档的编制要求同软件的规模联系起来。这就是本例的出发点。 这里，我们把软件的规模分为四级： (1) 小规模软件，源码行数小于5000； (2) 中规模软件，源码行数约10000～50000； (3) 大规模软件，源码行数约100000～500000； (4) 超大规模软件，源码行数大于500000。 对此，相应规模软件应该编制的文档种类，参见下表： 小规模软件 中规模软件 大规模软件 超大规模软件 软件需求与开发计划 项目开发计划 可行性报告 对应大规模软件所规定的文档种类，再做进一步细分 项目开发计划 软件需求说明 软件需求说明 数据要求说明 测试计划 测试计划 软件设计说明 软件设计说明 概要设计说明 详细设计说明 数据库设计说明 使用说明 使用说明 用户手册 操作手册 测试分析报告 模块开发卷宗 模块开发卷宗 测试分析报告 测试分析报告 项目开发总结 开发进度月报 开发进度月报 项目开发总结 项目开发总结 * 对于源码行数在5000～10000、50000～100000的软件，其文档编制的种类介于两级之间，可由项目负责人根据项目的具体情况，参照上表规定确定。 * 在本例中，我们再次使用上一个例子的问题，来尝试确定其应该编制的文档种类。 具体例题： 随着杭州逐步具备国际会展中心的基本功能，各类国际国内、专业民用展览，各种演出活动以及各种形式的会议、培训等活动将会