1、软件开发文档模板库1 可行性研究报告 可行性研究报告的编写目的是:说明该软件开发项目的实现在技术,经济和 社会条件方面的可行性;评述为了合理地达到开发目标而可能先择的各种方案; 说明论证所选定的方案. 可行性研究报告的编写内容要求如下:1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义1.1.4 参考资料1.2 可行性研究的前提1.2.1 要求 1.2.2 目标1.2.3 条件,假定和限制 1.2.4 进行可行性研究的方法1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷1.3.3 费用开支 1.3.4 人员1.3.5 设备
2、 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响1.4.4.3 对用户单位机构的影响1.4.4.4 对系统动行的影响1.4.4.5 对开发的影响1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响1.4.5 局限性1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案 11.5.2 可选择的系统方案 2 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资1.6.1.
3、2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6.2.1 一次性收益 1.6.2.2 非一次性收益 1.6.2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期1.6.5 敏感性分析1.7 社会条件方面的可行性 1.7.1 法律方面的可行性1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式, 把对于在开发过程中各项工作的 负责人员, 开发进度所需经费预算, 所需软, 硬件条件等问题作出安排记载下来, 以便根据本计划开展和检查本项目的开发工作.编制内容要求如下: 2.1 引言 2.1.1 编写目的 2
4、.1.2 背景2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员2.2.3 产品及成果 2.2.3.1 程序 2.2.3.2 文件2.2.3.3 服务 2.2.3.4 非移交产品2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点 3 软件需求说明书
5、 软件需求说明书的编制是为了使用户的软件开发者双方对该软件的起初规 定有一个共同的理解, 使之成为整个开发工作的基础.编制软件需求说明书的内 容要求如下: 3.1 引言 3.1.1 编写的目的 3.1.2 背景3.1.3 定义 3.1.1 参考资料 3.2 任务概述 3.2.1 目标 3.2.2 用户的点 3.2.3 假定与约束 3.3 需求规定 3.3.1 对功能的规定 3.3.2 对性能的规定 3.3.2.1 精度 3.3.2.2 时间特性要求 3.3.2.3 灵活性 3.3.3 输入输出要求 3.3.4 数据管理能力的要求3.3.5 故障处理要求 3.3.6 其它的专门的要求3.4 运行
6、环境规定3.4.1 设备 3.4.2 支持软件 3.4.3 接口 3.4.4 控制 4 数据需求说明书 数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描 述和数据采集要求的技术信息.编制数据要求说明书的内容要求如下:4.1 引言 4.1.1 编写目的 4.1.2 背景 4.1.3 定义 4.1.4 参考资料 4.2 数据的逻辑描述 4.2.1 静态数据 4.2.2 动态输入数据4.2.3 动态输出数据4.2.4 内部生成数据 4.2.5 数据约定 4.3 数据的采集 4.3.1 要求和范围 4.3.2 输入的承担者 4.3.3 处理 4.3.4 影响 5 概要设计说明书 概要设
7、计说明书可称作系统设计说明书,这里说的系统是指程序系统,编制 的目的是说明对程序的系统的设计考虑,包括程序系统的基本处理流程,程序系 统的组织结构,模块划分,功能分配,接口设计,运行设计,数据结构设计和出 错处理设计等,为程序的详细设计提供基础.编制概要设计说明书的内容要求如 下: 5.1 引言 5.1.1 编写目的 5.1.2 背景 5.1.3 定义 5.1.4 参考资料 5.2 总体设计 5.2.1 需求规定 5.2.2 运行环境 5.2.3 基本设计概念和处理流程 5.2.4 结构 5.2.5 功能需求与程序的关系 5.2.6 人工处理过程 5.2.7 尚未解决的问题 5.3 接口设计
8、5.3.1 用户接口 5.3.2 内部接口 5.3.3 外部接口 5.4 运行设计 5.4.1 运行模块组合 5.4.2 运行控制 5.4.3 运行时间 5.5 系统数据结构设计 5.5.1 逻辑结构设计要点 5.5.2 物理结构设计要点 5.5.3 数据结构与程序的关系 5.6 系统出错处理设计 5.6.1 出错信息 5.6.2 补救措施 5.6.3 系统维护设计 6 详细设计说明书详细说明书可称作程序设计说明书. 编制目的是说明一个软件系统各个层次 中的每一个程序 (每个模块或子程序) 的设计考虑, 如果一个软件系统比较简单, 层次很少,本文件可以不单独编写,有关内容合并概要设计说明书.对
9、详细设计 说明书的内容要不得要求如下 : 6.1 引言 6.1.1 编写目的 6.1.2 背景 6.1.3 定义 6.1.4 参考资料 6.2 程序系统的组织结构 6.3 程序 1(标识符)设计说明 6.3.1 程序描述 6.3.2 功能 6.3.3 性能 6.3.4 输入项 6.3.5 输出项 6.3.6 算法 6.3.7 流程逻辑 6.3.8 接口 6.3.9 存储分配 6.3.10 注释设计 6.3.11 限制条件 6.3.12 测试计划 6.3.13 尚未解决的问题 6.4 程序 2(标识符)设计说明 7 数据库设计说明书 数据库设计说明书的编制目的是对于设计中的数据库所有标识, 逻辑
10、结构和 理结构作出具体的设计规定.其内容要求如下: 7.1 引言 7.1.1 编写目的 7.1.2 背景 7.1.3 定义 7.1.4 参考资料 7.2 外部设计 7.2.1 标识符和状态 7.2.2 使用它的程序 7.2.3约定 7.2.4 专门指导 7.2.5 支持软件 7.3 结构设计 7.3.1 概念结构设计 7.3.2 逻辑结构设计 7.3.3 理结构设计7.4 运用设计 7.4.1 数据字典设计 7.4.2 安全保密设计 8 用户手册 用户手册的编制是要使用非专门术语的语言, 充分地描述该软件系统工程所 具有的功能及基本的使用方法.使用户(或潜在用户)通过本手册能够了解该软 件的用
11、途,并且能够确定在什么情况下,如何使用它.具体的内容要求如下: 8.1 引言 8.1.1 编写目的 8.1.2 背景 8.1.3 定义 8.1.4 参考资料 8.2 用途 8.2.1 功能 8.2.2 性能 8.2.2.1 精度 8.2.2.2 时间特性 8.2.2.3 灵活性 8.2.3 安全保密 8.3 运行环境 8.3.1 硬设备 8.3.2 支持软件 8.3.3 数据结构 8.4 使用过程 8.4.1 安装与初始化 8.4.2 输入 8.4.2.1 输入数据的现实背景 8.4.2.2 输入格式 8.4.2.3 输入举例 8.4.3 输出 8.4.3.1 输出数据的现实背景 8.4.3.
12、2 输出格式 8.4.3.3 输出举例 8.4.4 文卷查询 8.4.5 出错处理与恢复 8.4.6 终端操作 9 操作手册 操作手册的编制是为了向操作人中提供该软件每一个运行的具体过程和有关知 识,包括操作方法的细节.具体的内容要求如下: 9.1 引言 9.1.1 编写目的 9.1.2 背景 9.1.3 定义 9.1.2 参考资料9.2 软件概述 9.2.1 软件的结构 9.2.2 程序表 9.2.3 文卷表 9.3 安装与初始化 9.4 运行说明 9.4.1 运行表 9.4.2 运行步骤 9.4.3 运行 1(标识符)说明 9.4.3.1 运行控制 9.4.3.2 操作信息 9.4.3.3
13、 输入-输出文卷 9.4.3.4 输出文段 9.4.3.5 输出文段的复制 9.4.3.6 启动恢复过程 9.4.4 运行 2(标识符)说明 9.5 非常规过程 9.6 远程操作10 模块开发卷宗 模块开发卷宗是在模块开发过程中逐步编写出来的, 每完成一个模块或一级 密切相关的模块的复审时编写一份,应该把所有的模块开发卷宗汇集在一起.编 写的目的是记录和汇总低层次开发的进度和结果, 以便于对整个模块开发工作的 管理和复审,并为将来的维护提供非常有用的技术信息.具体的内容要求如下: 10.1 标题 10.2模块开发情况表 10.3 功能说明 10.4 设计说明 10.5 源代码清单 10.6 测
14、试说明 10.7 复审的结论 11 测试计划 11.1 引言 11.1.1 编写目的 11.1.2 背景 11.1.3 定义 11.1.4 参考资料 11.2 计划 11.2.1 软件说明 11.2.2 测试内容 11.2.3 测试 1(标识符) 11.2.3.1 进度安排 11.2.3.2 条件 11.2.3.3 测试资料 11.2.3.4 测试培训11.2.4 测试 2(标识符) 11.3 测试设计说明 11.3.1 测试 1(标识符) 11.3.1.1 控制 11.3.1.2 输入 11.3.1.3 输出 11.3.1.4 过程 11.3.2 测试 2(标识符) 11.4 评价准则 11
15、.4.1 范围 11.4.2 数据整理 11.4.3 尺度 12 测试分析报告 测试分析报告的编写是为了把组装测试和确认测试的结果, 发现及分析写成 文件加发记载,具体的编写内容要求如下: 12.1 引言 12.1.1 编写目的 12.1.2 背景 12.1.3 定义12.1.4 参考资料 12.2 测度概要 12.3 测试结果及发现 12.3.1 测试 1(标 识符) 12.3.2 测试 2(标识符) 12.4 对软件功能的结论 12.4.1 功能 1(标识符) 12.4.1.1 能力 12.4.1.2 限制 12.4.2 功能 2(标识符) 12.5 分析摘要 12.5.1 能力 12.5
16、.2 缺陷和限制 12.5.3 建议 12.5.4 评价 12.6 测试资源消耗13 开发进度月报 开发进度月报的编制目的是及时向有关管理部门汇报项目开发的进展和情 况,以便函及时发现或处理开发过程中出现的问题.一般地,开发进度月报是以 项目组为单位每月编写的.如果被开发的软件系统规模比较大,整个工程项目被 划分给若干个分项目组承担,开发进度月报将以项目组为单位按月编写.具体的内容要求如下: 13.1 标题 13.2 工程进度与状态 13.2.1 进度 13.2.2 状态 13.3 资源耗用与状态 13.3.1 资源耗用 13.3.1.1 工时 13.3.1.2 机时 13.3.2 状态 13
17、.4 经费支出与状态 13.4.1 经费支出 13.4.1.1 支持性费用 13.4.1.2 设备购置费 13.4.2 状态 13.5 下个月的工作计划 13.6 建议 14 项目开发总结报告 项目开发总结报告的编制是为了总结本项目开发工作的经验, 说明实际取得 的开发结果以及对整个开发工作的各个方面的评价.具体的内容要求如下: 14.1 引言 14.1.1 编写目的 14.1.2背景 14.1.3 定义 14.1.4 参考资料 14.2 实际开发结果 14.2.1 产品 14.2.2 主要功能和性能 14.2.3 基本流程 14.2.4 进度 14.2.5 费用 14.3 开发工作评价 14.3.1 对生产效率的评价 14.3.2 对产品质量的评价 14.3.3 对技术方法的评价 14.3.4 出错原因的分析 14.4 经验与教训.
