1、1.1 几个常用软件文档的模板1.1.1 可行性研究报告可行性研究报告的主要内容包括说明该软件项目在技术、经济、实现、环境等方面是否可行；评述为了合理地达到开发目标而可能选择的各种方案；论证所选定的方案。XXXX 系统可行性研究1 引言1.1 编写目的此处说明编写本文档的目的，并指明读者对象。1.2 背景1.3 定义1.4 参考资料2 可行性研究的前提 2.1 要求2.2 目标2.3 条件、假定和限制2.4 可行性研究方法3 对现有系统的分析3.1 数据流程和处理流程3.2 工作负荷3.3 费用开支3.4 人员3.5 设备3.6 存在的主要问题4 所建议的系统4.1 对所建议系统的说明4.2
2、数据流程4.3 处理流程4.3 改进之处4.4 影响4.5 局限性4.6 技术条件方面的可行性5 可选择的其他系统方案5.1 可选择的系统方案 15.2 可选择的系统方案 26 投资及收益分析6.1 支出6.1.1 基本建设投资6.1.2 其他一次性支出6.1.3 非一次性支出6.2 收益6.2.1 一次性收益6.2.2 非一次性收益6.2.3 不可定量的收益6.3 收益/投资比6.4 投资回收周期6.5 敏感性分析7 社会因素方面的可行性7.1 法律方面的可行性7.2 使用方面的可行性8 结论1.1.2 项目开发计划编制项目开发计划的目的是：用文件的形式，对开发过程中各项工作的负责人员、开发
3、进度所需经费预算、所需软件和硬件条件等问题做出的安排记载下来，以便根据该计划开展和检查本项目的开发工作。编写内容要求如下。XXXX 系统开发计划1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 项目概述2.1 工作内容2.2 主要参加人员2.3 产品及成果2.3.1 程序2.3.2 文件2.3.3 服务2.3.4 非移交产品2.4 验收标准2.5 完成项目的最迟期限2.6 本计划的审查者与批准者3 实施总计划3.1 工作任务的分解3.2 接口人员3.3 进度3.4 预算3.5 关键问题4 支持条件4.1 计算机系统支持4.2 需要用户承担的工作4.3 需由外单位提供的条件5
4、专题计划要点1.1.3 软件需求说明书软件需求说明书的编制是为了使用户和软件开发者双方对该软件要完成的任务有一个共同的认识，这是整个开发工作的基础。编写内容要求如下。XXXX 系统需求规格说明书1. 引言给出对本说明书的概述。1.1 目的编写本文档的目的。1.2 文档约定描述本文档的排版约定，解释各种符号的意义。1.3 各类读者的阅读建议对本文档各类读者的阅读建议。1.4 软件的范围描述软件的范围和目标。1.5 参考文献编写本文档所参考的资料清单。2. 综合描述描述软件的运行环境、用户和其他已知的限制、假设和依赖。2.1 软件前景软件产品的背景和前景。2.2 软件的功能和优先级概要描述软件的主
5、要功能，详细功能描述在后面的章节中。在此给出一个功能列表或者功能方块图，对于理解软件的功能是有益处的。2.3 用户类和特征描述使用软件产品的不同用户类和相关特征、操作权限。2.4 运行环境描述软件产品的运行环境，包括硬件平台、操作系统、其他软件组件。如果本软件是一个较大系统的一部分，则在此简单描述这个大系统的组成和功能，特别要说明它的接口。2.5 设计和实现上的限制概要说明针对开发人员开发系统的各种限制，包括：软硬件限制，与其他应用软件的接口，并行操作，审查功能，控制功能，开发语言，通讯协议，应用的临界点，安全和保密方面的限制。但是，此处不说明限制的理由。2.6 假设和依赖描述影响软件开发的假
6、设条件，说明软件运行对外部因素的依赖情况。3. 功能需求3.1 引言软件要达到的目标，实现功能所采用的方法和技术，系统的高层数据流程图。3.2 功能说明以细化的数据流程图为核心，详细描述其中的各个功能需要的输入信息，加工步骤，出现异常的响应等。4数据要求描述与功能有关的数据定义和数据关系。4.1 数据实体关系可以用 E-R 图描述数据实体之间的关系。4.2 数据项或数据结构用数据字典对数据流程图中的数据流和数据存储或其他有关的数据项进行详细地说明。4.3 数据库描述对数据库的要求，特别是完备性、安全性和效率等指标。5.性能需求产品的性能指标，包括产品响应时间、容量要求、用户数要求，例如：支持的
7、终端用户数，系统允许并发操作的用户数，系统可处理的最大文件数和记录数，欲处理的事务和任务数量，在正常情况下和峰值情况下的事务处理能力。6外部接口所有与外部接口有关的需求都应该在这部分说明。6.1 用户界面描述软件用户界面的标准和风格，不包括详细的界面布局设计。6.2 硬件接口系统运行环境中各硬件的接口。6.3 软件接口描述软件与其他外部组件的连接，包括数据库、软件库、中间件等。6.4 通信接口描述软件与通讯有关的需求，如信息格式、通讯安全、速率、通讯协议等。7. 设计约束说明对设计的约束及其原因。7.1 硬件限制硬件配置的特点。7.2 软件限制指定软件运行环境，描述与其他软件的接口。7.3 其
8、他约束约束和原因，例如，用户要求的报表风格，要求遵守的数据命名规范等。8. 软件质量属性描述软件要求的质量特性。9. 其他需求描述所有在说明书其他部分未能体现的需求。9.1 产品操作需求用户要求的常规操作和特殊操作。9.2 场合适应性需求指出在特定场合和操作方式下的特殊需求。附录 1：词汇表定义所有必要的术语，以便读者可以正确理解本文档的内容。附录 2：待定问题列表本说明书中所有待定问题的清单。1.1.4 数据需求说明书数据需求说明书的编制目的是为了提供关于处理数据的描述和数据采集要求的技术信息。编写内容要求如下。1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 数据的逻辑描
9、述2.1 静态数据2.2 动态输入数据2.3 动态输出数据2.4 内部生成数据2.5 数据约定3 数据的采集3.1 要求和范围3.2 输入的承担者3.3 处理3.4 影响1.1.5 概要设计说明书概要设计说明书也叫做系统设计说明书，编制的目的是为了说明软件体系结构，包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编写内容要求如下。XXXX 概要设计说明书1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 总体设计2.1 需求规定2.2 运行环境2.3 基本设计概念和处理流程2.4 结构2.5
10、 功能需求与程序的关系2.6 人工处理过程2.7 尚未解决的问题3 接口设计3.1 用户接口3.2 内部接口3.3 外部接口4 运行设计4.1 运行模块组合4.2 运行控制4.3 运行时间5 系统数据结构设计5.1 逻辑结构设计要点5.2 物理结构设计要点5.3 数据结构与程序的关系6 系统出错处理设计6.1 出错信息6.2 补救措施6.3 系统维护设计1.1.6 详细设计说明书详细说明书也叫做程序设计说明书。编制目的是说明一个系统各个层次中每一个程序（模块或子程序）的设计考虑。如果一个系统比较简单，层次很少，可以将有关内容合并到概要设计说明书中。详细设计说明书的内容如下。XXXX 详细设计说
11、明书1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 程序系统的组织结构3 程序 1（标识符）设计说明3.1 程序描述3.2 功能3.3 性能3.4 输入项3.5 输出项3.6 算法3.7 流程逻辑3.8 接口3.9 存储分配3.10 注释设计3.11 限制条件3.12 测试计划3.13 尚未解决的问题4 程序 2（标识符）设计说明1.1.7 数据库设计说明书数据库设计说明书的编制目的是对数据库中使用的所有标识、逻辑结构和物理结构做出具体的设计规定。其内容要求如下。XXXX 数据库设计说明书1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 外部设计2.1 标
12、识符和状态2.2 使用它的程序2.3 约定2.4 专门指导2.5 支持软件3 结构设计3.1 概念结构设计3.2 逻辑结构设计3.3 物理结构设计4 运用设计4.1 数据字典设计4.2 安全保密设计1.1.8 用户手册用户手册的编制是用非专业术语清晰地描述系统所具有的功能及基本使用方法。使用户（或潜在用户）通过本手册能够了解该系统的用途，并且能够确定如何使用它。具体内容要求如下。XXXX 系统用户手册1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 用途2.1 功能2.2 性能2.2.1 精度2.2.2 时间特性2.2.3 灵活性2.3 安全保密3 运行环境3.1 硬设备3.
13、2 支持软件3.3 数据结构4 使用过程4.1 安装与初始化4.2 输入4.2.1 输入数据的现实背景4.2.2 输入格式4.2.3 输入举例4.3 输出4.3.1 输出数据的现实背景4.3.2 输出格式4.3.3 输出举例4.4 文卷查询4.5 出错处理与恢复4.6 终端操作1.1.9 操作手册操作手册的编制是为了向操作人员提供该系统中每一个运行的具体过程和有关知识，包括操作方法的细节。具体内容要求如下。XXXX 系统操作手册1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 软件概述2.1 软件的结构2.2 程序表2.3 文卷表3 安装与初始化4 运行说明4.1 运行表4.
14、2 运行步骤4.3 运行 1（标识符）说明4.3.1 运行控制4.3.2 操作信息4.3.3 输入-输出文卷4.3.4 输出文段4.3.5 输出文段的复制4.3.6 启动恢复过程4.4 运行 2（标识符）说明5 非常规过程6 远程操作1.1.10 模块开发卷宗模块开发卷宗是在模块开发过程中逐步编写的，每完成一个模块编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。具体内容要求如下。XXXX 模块开发卷宗1 模块名称2 模块开发情况表3 功能说明4 设计说明5 源代码清单6 测试说明7
15、 复审的结论1.1.11 测试计划XXXX 系统测试计划1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 计划2.1 软件说明2.2 测试内容2.3 测试 1（标识符）2.3.1 进度安排2.3.2 条件2.3.3 测试资料2.3.4 测试培训2.4 测试 2（标识符）3 测试设计说明3.1 测试 1（标识符）3.1.1 控制3.1.2 输入3.1.3 输出3.1.4 过程3.2 测试 2（标识符）4 评价准则4.1 范围4.2 数据整理4.3 尺度1.1.12 测试分析报告测试分析报告是为了把组装测试和确认测试的结果、发现的问题及问题分析编写成文件，为开发、维修人员修改维护
16、系统服务。具体编写内容要求如下：XXXX 系统测试分析报告1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 测度概要3 测试结果及发现的问题3.1 测试 1（标识符）3.2 测试 2（标识符） 4 对软件功能的结论4.1 功能 1（标识符）4.1.1 能力4.1.2 限制4.2 功能 2（标识符）5 分析摘要5.1 能力5.2 缺陷和限制5.3 建议5.4 评价6 测试资源消耗1.1.13 开发进度月报开发进度月报的编制目的是及时向有关管理部门汇报项目开发的进展和情况，以便及时发现和处理开发过程中出现的问题。一般地，开发进度月报是以项目组为单位每月编写。如果被开发的软件系统规
17、模比较大，整个工程项目被划分给若干个分项目组承担，开发进度月报将以项目组为单位按月编写。具体内容要求如下：XXXX 系开发进度月报1 标题2 工程进度与状态2.1 进度2.2 状态3 资源耗用与状态3.1 资源耗用3.1.1 工时3.1.2 机时3.2 状态4 经费支出与状态4.1 经费支出4.1.1 支持性费用4.1.2 设备购置费4.2 状态5 下个月的工作计划6 建议1.1.14 项目开发总结报告项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发成果以及对整个开发工作各个方面的评价。具体内容要求如下：XXXX 项目开发总结报告1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 实际开发结果2.1 产品2.2 主要功能和性能2.3 基本流程2.4 进度2.5 费用3 开发工作评价3.1 对生产效率的评价3.2 对产品质量的评价3.3 对技术方法的评价3.4 出错原因分析4 经验与教训
