十三种项目文档编写模板

十三种项目文档编写模板内容摘要：

书的目的，指明读者对象。 项目背景：应包括项目的来源和主管部门等。 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。 参考资料： ● 列出有关资料的作者、标题 、编号、发表日期、出版单位或资料来源 ●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；概要设计说明书；测试计划（初稿）；用户操作手册 ● 文档所引用的资料、软件开发的标准或规范。 2 总体设计 需求概述 软件结构：如给出软件系统的结构图。 3 程序描述 逐个模块给出以下说明： ● 功能 ● 性能 ● 输入项目 ● 输出项目 算法：模块所选用的算法。 程序逻辑：详细描述模块实现的算法，可采用 ：标准流程图； PDL 语言； NS 图；判定表等描述算法的图表。 接口 ● 存储分配 ● 限制条件 测试要点：给出测试模块的主要测试要求。 用户操作手册 1 引言 编写目的：阐明编写手册的目的，指明读者对象。 项目背景：说明项目的来源、委托单位、开发单位及和主管部门。 定义：列出手册中使用的专门术语的定义和缩写词的愿意。 参考资料： ● 列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源 ● 项目经核准的计划任务书 、合同或上级机关的批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；测试计划 ● 文档中所引用的其他资料、采用的软件工程标准或软件工程规范。 2 软件概述 目标 功能 性能 数据精确度：包括输入、输出及处理数据的精度。 时间特性：如响应时间、处理时间、数据传输时间等。 灵活性：在操作方式、运行环境需做某些变更时软件的适应能力。 3 运行环境 硬件 ● 列出软件系统运行时所需的硬件最小配置，如计算机型号、主 存容量 ● 外存储器、媒体、记录格式、设备型号及数量 ● 输入、输出设备 ● 数据传输设备及数据转换设备的型号及数量。 支持软件 ● 操作系统名称及版本号 ● 语言编译系统或汇编系统的名称及版本号 ● 数据库管理系统的名称及版本号 ● 其他必要的支持软件 4 使用说明 安装和初始化：给出程序的存储形式、操作命令、反馈信息及其做含意、表明安装完成的测试实例以及安装所需的软件工具等。 输入：给出输入数据或参数的要求。 ● 数据背景： 说明数据来源、存储媒体、出现频度、限制和质量管理等。 ● 数据格式 :如长度、格式基准、标号、顺序、分隔符、词汇表、省略和重复、控制。 ● 输入举例。 输出：给出每项输出数据的说明。 ● 数据背景：说明输出数据的去向、使用频度、存放媒体及质量管理等。 ● 数据格式：详细阐明每一输出数据的格式，如首部、主体和尾部的具体形式。 ● 举例 出错和恢复：给出出错信息及其含意；用户应采取的措施，如修改、恢复、再启动。 求助查询：说明如何操作。 5 运行说明 运行表：列出每种可能的运行情况，说明其运行目的。 运行步骤：按顺序说明每和运行的步骤，应包括： 运行控制 操作信息：运行目的、运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项； 输入 /输出文件：给出建立或更新文件的有关信息，如：文件的名称及编号；记录媒体；存留的目录；文件的支配：说明确定保留文件或废弃文件的准则，分发文件的对象，战胜硬件的优先级及保密控制等。 启动或恢复过程 6 非常规过程 提供应急戒非常规操作的必要信 息及操作步骤，如出错处理操作、向后备系统切换操作及维护人员须知的操作和注意事项。 7 操作命令一览表 按字母顺序逐个列出全部操作命令的格式、功能及参数说明。 8 程序文件（或命令文件）和数据文件一览表 按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。 9 用户操作举例 测试计划 1 引言 编写目的：阐明编写测试计划的目的并指明读者对象。 项目背景：说明项目的来源、委托单位及主管部门。 定义：列出测试 计划中所用到的专门术语的定义和缩 写词的原意。 参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；本测试计划中引用的其他资料、采用 的软件开发标准或规范。 2 任务概述 目标 运行环境 需求概述 条件与限制 3 计划 测试方案：说明测试方法和选取测试用例的原则。 测试项目：列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。 测试准备 测试机构及人员：测试机构名称、负责人和职责。 4 测试项目说明 按顺序逐个对测试项目做出说明 测试项目名称及测试内容 测试用例 输入：输入的数据和输入命令。 输出：预期的输出数据。 步骤及操作 允许偏差。