本书是“软件开发与测试丛书”中的一册，是一本指导软件开发与测试文档编写的实用指南。全书以大型软件的常用开发过程为例，参考相关标准规范要求，系统地介绍了软件需求文档、软件设计文档、软件测试文档、软件使用性文档和软件项目管理文档5大类20种具体文档的编写要求，给出了文档内容模板和部分文档内容的具体示例，并总结了常见的文档编写问题。全书共21章，介绍的具体文档包括系统规格说明、接口需求规格说明、软件研制任务书、软件需求规格说明、系统设计说明、接口设计说明、数据库设计说明、软件概要设计说明、软件详细设计说明、软件测试计划、软件测试说明、软件测试报告、软件回归测试方案、软件产品规格说明、软件版本说明、软件使用手册、软件开发计划、软件配置管理计划、软件质量保证和软件研制总结报告。
本书旨在帮助软件从业人员提升对软件文档重要性的认识，提高软件文档的编写质量，针对性和实用性较强。既可供需要进行软件文档编写的工程实践人员参考，也可供相关单位进行标准化推广和质量管理体系建设工作借鉴。

第一篇 基础篇
第1章 软件开发和测试文档要求
1.1 软件开发过程概述
1.2 相关术语
1.3 软件开发文档要求
1.3.1 文档的作用
1.3.2 软件文档标准
1.3.3 软件文档的种类
1.4 软件文档裁剪指南
1.4.1 软件规模等级
1.4.2 软件关键等级
1.4.3 文档的裁剪
第二篇 软件需求文档
第2章 系统规格说明
2.1 系统规格说明的编写要求
2.2 系统规格说明的内容
2.3 系统规格说明编写示例
2.3.1 系统概述
2.3.2 系统功能
2.3.3 系统外部接口需求
2.3.4 安全性需求
2.3.5 操作需求
2.4 系统规格说明的常见问题
第3章 软件研制任务书
3.1 软件研制任务书的编写要求
3.2 软件研制任务书的内容
3.3 软件研制任务书编写示例
3.3.1 软件概述
3.3.2 总体开发要求
3.3.3 功能要求
3.3.4 性能要求
3.3.5 接口关系
3.3.6 运行环境
3.3.7 支持环境
3.3.8 设计约束
3.3.9 管理要求
3.3.10 验收与交付
3.3.11 维护
3.4 软件研制任务书的常见问题
第4章 软件需求规格说明
4.1 软件需求规格说明的编写要求
4.2 软件需求规格说明的内容
4.2.1 软件需求规格说明（结构化方法）
4.2.2 软件需求规格说明（面向对象方法）
4.3 软件需求规格说明编写示例
4.3.1 外部接口需求
4.3.2 功能需求说明
4.3.3 性能需求说明
4.3.4 设计约束
4.3.5 运行环境要求
4.3.6 合格性需求
4.3.7 交付需求
4.3.8 维护保障需求
4.4 软件需求规格说明的常见问题
第5章 接口需求规格说明
5.1 接口需求规格说明的编写要求
5.2 接口需求规格说明的内容
5.3 接口需求规格说明编写示例
5.3.1 接口示意图
5.3.2 接口需求
5.4 接口需求规格说明的常见问题57第三篇 软件设计文档
第6章 系统设计说明
6.1 系统设计说明的编写要求
6.2 系统设计说明的内容
6.3 系统设计说明示例
6.3.1 系统设计
6.3.2 CSCI标识
6.3.3 接口关系
6.3.4 软件配置项关键与规模等级划分
6.4 系统设计说明的常见问题
第7章 软件接口设计说明
7.1 软件接口设计说明的编写要求
7.2 软件接口设计说明的内容
7.3 软件接口设计说明示例
7.3.1 接口示意图
7.3.2 数据元素
7.3.3 消息描述
7.3.4 通信协议
7.4 软件接口设计说明的常见问题
第8章 数据库设计说明
8.1 数据库设计说明的编写要求
8.2 数据库设计说明的内容
8.3 数据库设计说明示例
8.3.1 数据库概要设计
8.3.2 数据库详细设计
8.3.3 数据库访问和操作软件单元设计
8.4 数据库设计说明的常见问题
第9章 软件概要设计说明
9.1 软件概要设计说明的编写要求
9.2 软件概要设计说明的内容
9.3 结构化设计方法概要设计说明示例
9.3.1 CSCI结构设计
9.3.2 CSCI接口设计
9.3.3 内存和处理时间分配
9.3.4 CSCI设计说明
9.3.5 CSCI数据
9.3.6 CSCI数据文件
9.4 面向对象设计方法概要设计说明示例
9.4.1 逻辑视图
9.4.2 进程视图
9.4.3 实现视图
9.4.4 部署视图
9.5 软件概要设计说明的常见问题
第10章 软件详细设计说明
10.1 软件详细设计说明的编写要求
10.2 软件详细设计说明的内容
10.3 结构化方法详细设计说明示例
10.4 面向对象方法详细设计说明示例
10.5 软件详细设计说明的常见问题
第四篇 软件测试文档
第11软件测试计划
11.1 软件测试计划的编写要求
11.2 软件测试计划的内容
11.2.1 软件测试计划模板
11.2.2 软件测评大纲模板
11.3 软件测试计划编写示例
11.3.1 被测软件概述
11.3.2 测试总体要求的描述
11.3.3 测试项及测试方法
11.3.4 测试环境
11.3.5 测试结束条件
11.3.6 软件质量评价方法与内容
11.3.7 测试通过准则
11.4 软件测试计划的常见问题
第12章 软件测试说明
12.1 软件测试说明的编写要求
12.2 软件测试说明的内容
12.3 软件测试说明编写示例
12.3.1 文档审查
12.3.2 代码审查
12.3.3 静态分析
12.3.4 逻辑测试
12.3.5 功能测试
12.3.6 性能及余量测试
12.3.7 接口测试
12.3.8 强度测试
12.3.9 安全性测试
12.3.10 恢复性测试
12.3.11 边界测试
12.3.12 互操作性测试
12.3.13 安装性测试
12.4 软件测试说明的常见问题
第13章 软件测试报告
13.1 软件测试报告编写要求
13.2 软件测试报告内容
13.3 软件测试报告示例
13.3.1 测试过程概述
13.3.2 未执行测试