软件文档的编写原则
所有的章节都可以进一步细分或缩并，以适应实际需要。
程序的设计表现形式可以使用多种形式，如流程图、判定表、等其 他表现形式。
按规定：重量不超过30公斤的行李可免费托运。重量超过30公斤时， 对超运部分，头等舱国内乘客收4元/公斤；其它舱位国内乘客收6元 /公斤；外国乘客收费为国内乘客的2倍；残疾乘客的收费为正常乘 客的1/2。
（6）详细设计说明书
（7）数据库设计说明书
本指南不仅给出了这十四种文档的编制指导，同时，本指南也是这十四种文 档编写质量的检验准则。
2、软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南为软件需求的实践提供了一个规 范化的方法，主要描述了软件需求说明（Software Requirements Specifications，简称SRS）所必须的内容 和质量。
软件需求标准适用范围
1. 指南适用对象 软件客户（Customers），以便精确地描述他们想获得什么样的产品。 软件开发者（Suppliers），以便准确地理解客户需要什么样的产品。 2. 指南目的 对于任一单位和（或）个人，要实现下列目标： a. 要提出开发规范化的SRS提纲； b. 定义自己需要的具体的格式和内容； c.产生附加的局部使用条款，如SRS质量检查清单或者SRS作者手册等。
实例
4、软件文档管理指南
软件文档管理指南
软件文档管理指南是为那些对软件或基于软件的产品的开发负有职 责的管理者提供软件文档的管理指南。其目的在于协助管理者在他 们的机构中产生有效的文档。
（1）软件文档管理涉及策略、标准、规程、资源和计划，管理者必 须关注这些内容，以便有效地管理软件文档。 （2）软件文档管理期望应用于各种类型的软件，从简单的程序到复 杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存 期的各个阶段。 （3）不论项目的大小，软件文档管理的原则是一致的。对于小项目， 可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满 足他们的特殊需要。 （4）软件文档管理是针对文档编制管理而提出的，不涉及软件文档 的内容和编排。
文 档 的 扩 展
章 节 的 扩 张 与 缩 并 程序 设计 的表 现形 式
文 档 种 类
文 档 详 细 程 度
文 档 的 表 现 形 式
ቤተ መጻሕፍቲ ባይዱ
文 档 其 他 种 类
软件文档的编写原则
文档编制的原则 文档编 写应适 应文档 的读者 文档编写 应有必要 的重复性 文档编写 应具有一 定灵活性
文 档 的 扩 展
软件文档写作
第四章 软件文档写作要求
浙江工业大学计算机学院
陆佳炜
主要内容
软件文档的编写原则 制定文档的编写策略 软件文档的质量等级 制定文档的编制计划 建立文档的编制规程 软件文档的质量要求 软件文档的编写技巧 确定软件文档类型的种类
1、软件文档的编写原则
软件文档的编写原则
文档编制的原则 文档编 写应适 应文档 的读者 文档编写 应有必要 的重复性 文档编写 应具有一 定灵活性
软件需求文档的基本要求
SRS是对要完成一定功能、性能的软件产品、程序或一组程序 的说明。因此对SRS的描述有两项基本要求： （1）必须描述一定的功能、性能； （2）必须用确定的方法叙述这些功能、性能。 SRS作为软件开发规范之一，对软件开发的所有阶段都起着非 常重要的作用，但是需要注意的是，SRS不能超出其作用范围， 即除了SRS正确地定义所有软件的需求之外，一般地SRS不描 述任何设计、验证或项目管理的细节。
3、软件文档的质量等级
测试文档的结构
软件测试文档的内容主要包括： 测试计划 测试设计说明 测试用例说明 测试规程说明 测试项传递报告 测试日志 测试事件报告以及测试总结报告
1、测试计划
1 测试计划名称 2 引言 3 测试项 4 被测试的特性 5 不被测试的特性 6 方法 7 项通过准则 8 暂停标准和再启动要求 9 应提供的测试文件 10 测试任务 11 环境要求 12 职责 13 人员和训练要求 14 进度 15 风险和应急 16 批准
软件产品开发文件编制指南
根据该指南，一项计算机软件的开发过程中，一般应产生如下十四种文档：
（1）可行性研究报告 （2）项目开发计划
（3）软件需求说明书
（4）数据要求说明书 （5）概要设计说明书
（8）用户手册 （9）操作手册 （10）模块开发卷宗 （11）测试计划 （12）测试分析报告 （13）开发进度月报 （14）项目开发总结报告
软件需求文档的编制目标
SRS对于软件客户来讲，应尽可能准确地描述其所需要的产品；而对于软 件开发者，应能准确地理解客户所需要的产品。 编制SRS的目标可以概括为如下六个方面： （1）在软件产品完成目标方面为客户和开发者之间建立共同协议创立一个基 础 （2）提高开发效率 （3）为成本计价和编制计划进度提供基础 （4）为确认和验证提供一个基准 （5）便于移植 （6）作为不断提高的基础
3、软件测试文档编制规范
软件测试文档编制规范
测试是软件生存周期中一个独立的、关键的阶段，也是 保证软件质量的重要手段。为了提高检测出错误的几率， 使测试能有计划地、有条不紊地进行，就必须要编制测 试文档。而标准化的测试文档就如同一种通用的参照体 系，可达到便于交流的目的。
计算机软件测试文档编制规范的目的就是规定一组软件 测试文档，定义每一种基本文档的目的、格式和内容。 测试文档中所规定的内容可以作为对测试过程完备性的 对照检查表，这将会提高测试过程的每个阶段的能见度， 极大地提高测试工作的可管理性。
2006年后 计算机软件产品开发文件编制指南 （GBT8567-2006） 计算机软件测试文件编制规范 （GBT9386-2008）
软件产品开发文件编制指南
计算机软件产品开发文档编制指南是一份指导性文档，目的是使得 所编制的软件文档确实能够起到应该发挥的作用。 指南对软件文档的意义和作用、文档与读者的关系、软件生存周期 与各种文档的编制、文档编制中的考虑因素、文档编制的管理工作 以及各种文档的内容要求都作了详细描述，并给出了各类文档的编 写提示。
5、测试项传递报告
1 传递报告名称 2 传递项 3 位置 4 状态 5 批准
6、测试日志
1 测试日志名称 2 描述 3 活动和事件条目
7、测试事件报告
1 测试事件报告名称 2 摘要 3 事件描述 4 影响
8、测试总结报告
1 2 3 4 5 6 7 8 测试总结报告名称 简述 差异 测试充分性评价 结果概述 评价 活动总结 批准
测试文档的编制
软件测试文档的内容主要包括测试计划、测试设计说明、 测试用例说明、测试规程说明、测试项传递报告、测试 日志、测试事件报告以及测试总结报告八项内容。 需要强调，软件测试包括对需求说明书的测试，因此， 在软件的需求分析阶段，就应开始测试文档的编制工作， 各种测试文档的编写应按一定的格式进行
软件文档写作
第三章 软件文档国家标准
浙江工业大学计算机学院
陆佳炜
主要内容
软件产品开发文档编制指南
软件需求说明编制指南
软件测试文档编制规范 软件文档管理指南
1、软件产品开发文档编制指南
软件文档国家标准
计算机软件产品开发文档编制指南 （GB 8567-1988） 计算机软件需求说明编制指南 （GB 9385-1988） 计算机软件测试文档编制规范 （GB 9386-1988） 软件文档管理指南 （GB 16680-1996）
软件测试文档内容
计算机软件测试文档编制规范主要定义了三种类型 软件测试文档： 测试计划 测试说明 测试报告
测试计划
测试计划描述测试活动的范围、方法、资源和进 度。它规定被测试的项、被测试的特性、应完成 的测试任务、担任各项工作的人员职责及与本计 划有关的风险等
测试说明
测试说明包括三个文档： （1）测试设计说明 详细描述测试方法，规定该设计及其有关测试所包括的特性(功能、性能、 可移植性等)，还规定完成测试所需的测试用例和测试规程，并规定特性 的通过准则。 （2）测试用例说明 列出用于输入的具体值以及预期的输出结果，并规定在使用具体测试用例 时，对测试规程的各种限制。将测试用例与测试设计分开，可以使它们用 于多个设计并能在其它情形下重复使用。 （3）测试规程说明 规定对于运行系统和执行指定的测试用例来实现有关测试设计所要求的所 有步骤。
测试报告
测试报告包括四类文档： （1）测试项传递报告 所谓的测试项是指作为测试对象的软件项（源代码、目标代码、作业控制 代码、数据等），该报告指明在开发组和测试组独立工作的情况下或者在 希望正式开始测试的情况下为进行测试而被传递的测试项。 （2）测试日志 测试组用于记录测试执行过程中发生的情况。 （3）测试事件报告 描述在测试执行期间发生并需进一步调查的一切事件。 （4）测试总结报告 总结与测试设计说明有关的测试活动。
测试文档的编制
文件 活动 验收 安装 系统 子系统 测试计 划 √ √ √ 测试设 计说明 √ √ √ 测试用 例说明 √ √ √ √ 测试规 程说明 √ √ √ 测试项 传递报 告 √ √ √ √ 测试日 志 √ √ 测试事 件 报告 √ √ √ √ 测试总 结 报告 √ √ √ √ √
模块
-
√
文档标准应被标识和使用
应规定支持工具
制定文档的编写策略
评估现有策略条款的有效性和完整性的文档检查表
——适当的文档的决策作出了吗？ ——涉及文档的策略声明发布了吗？ ——负责开发文档和产品文档编写工作的人员或部门落实了吗？ ——用于文档编制的资源落实了吗？ ——负责文档质量的人员或部门落实了吗？ ——各管理层次和组织各分支之间的各种关系确定了吗？ ——对于文档的编制、分发和维护等方面是否确定了职责、所需活动和联系 途径？ ——所有的文档要求已列入整个项目开发计划表中了吗？ ——适用的文档标准已确定了吗？ ——是否已考虑采用支持工具和自动化的文档编制？