软件开发与测试丛书软件开发与测试文档编写指南

目录

第1章软件开发和测试文档要求3

1.1软件开发过程概述3

1.2相关术语5

1.3软件开发文档要求5

1.3.1文档的作用5

1.3.2软件文档标准6

1.3.3软件文档的种类6

1.4软件文档裁剪指南8

1.4.1软件规模等级9

1.4.2软件关键等级9

1.4.3文档的裁剪10

第二篇软件需求文档

第2章系统规格说明15

2.1系统规格说明的编写要求15

2.2系统规格说明的内容16

2.3系统规格说明编写示例20

2.3.1系统概述20

2.3.2系统功能21

2.3.3系统外部接口需求22

2.3.4安全性需求22

2.3.5操作需求22

2.4系统规格说明的常见问题23

第3章软件研制任务书24

3.1软件研制任务书的编写要求24

3.2软件研制任务书的内容25

3.3软件研制任务书编写示例26

3.3.1软件概述27

3.3.2总体开发要求28

3.3.3功能要求28

3.3.4性能要求28

3.3.5接口关系29

3.3.6运行环境30

3.3.7支持环境31

3.3.8设计约束31

3.3.9管理要求31

3.3.10验收与交付32

3.3.11维护33

3.4软件研制任务书的常见问题33

第4章软件需求规格说明35

4.1软件需求规格说明的编写要求35

4.2软件需求规格说明的内容36

4.2.1软件需求规格说明（结构化方法）36

4.2.2软件需求规格说明（面向对象方法）40

4.3软件需求规格说明编写示例42

4.3.1外部接口需求43

4.3.2功能需求说明44

4.3.3性能需求说明46

4.3.4设计约束47

4.3.5运行环境要求47

4.3.6合格性需求47

4.3.7交付需求48

4.3.8维护保障需求48

4.4软件需求规格说明的常见问题49

第5章接口需求规格说明51

5.1接口需求规格说明的编写要求51

5.2接口需求规格说明的内容51

5.3接口需求规格说明编写示例53

5.3.1接口示意图53

5.3.2接口需求55

5.4接口需求规格说明的常见问题57第三篇软件设计文档

第6章系统设计说明61

6.1系统设计说明的编写要求61

6.2系统设计说明的内容62

6.3系统设计说明示例63

6.3.1系统设计63

6.3.2CSCI标识65

6.3.3接口关系66

6.3.4软件配置项关键与规模等级划分66

6.4系统设计说明的常见问题67

第7章软件接口设计说明68

7.1软件接口设计说明的编写要求68

7.2软件接口设计说明的内容69

7.3软件接口设计说明示例70

7.3.1接口示意图70

7.3.2数据元素72

7.3.3消息描述73

7.3.4通信协议74

7.4软件接口设计说明的常见问题74

第8章数据库设计说明75

8.1数据库设计说明的编写要求75

8.2数据库设计说明的内容76

8.3数据库设计说明示例78

8.3.1数据库概要设计78

8.3.2数据库详细设计80

8.3.3数据库访问和操作软件单元设计82

8.4数据库设计说明的常见问题84

第9章软件概要设计说明85

9.1软件概要设计说明的编写要求85

9.2软件概要设计说明的内容87

9.3结构化设计方法概要设计说明示例92

9.3.1CSCI结构设计92

9.3.2CSCI接口设计92

9.3.3内存和处理时间分配94

9.3.4CSCI设计说明94

9.3.5CSCI数据98

9.3.6CSCI数据文件99

9.4面向对象设计方法概要设计说明示例100

9.4.1逻辑视图100

9.4.2进程视图101

9.4.3实现视图103

9.4.4部署视图104

9.5软件概要设计说明的常见问题104

第10章软件详细设计说明106

10.1软件详细设计说明的编写要求106

10.2软件详细设计说明的内容107

10.3结构化方法详细设计说明示例110

10.4面向对象方法详细设计说明示例112

10.5软件详细设计说明的常见问题116

第四篇软件测试文档

第11软件测试计划123

11.1软件测试计划的编写要求124

11.2软件测试计划的内容125

11.2.1软件测试计划模板125

11.2.2软件测评大纲模板129

11.3软件测试计划编写示例131

11.3.1被测软件概述131

11.3.2测试总体要求的描述133

11.3.3测试项及测试方法134

11.3.4测试环境142

11.3.5测试结束条件144

11.3.6软件质量评价方法与内容144

11.3.7测试通过准则147

11.4软件测试计划的常见问题147

第12章软件测试说明150

12.1软件测试说明的编写要求150

12.2软件测试说明的内容152

12.3软件测试说明编写示例154

12.3.1文档审查154

12.3.2代码审查155

12.3.3静态分析163

12.3.4逻辑测试165

12.3.5功能测试166

12.3.6性能及余量测试168

12.3.7接口测试170

12.3.8强度测试172

12.3.9安全性测试174

12.3.10恢复性测试177

12.3.11边界测试178

12.3.12互操作性测试179

12.3.13安装性测试181

12.4软件测试说明的常见问题183

第13章软件测试报告185

13.1软件测试报告编写要求186

13.2软件测试报告内容186

13.3软件测试报告示例191

13.3.1测试过程概述191

13.3.2未执行测试用例情况说明192

13.3.3测试有效性、充分性说明193

13.3.4评价结论193

13.3.5改进建议196

13.3.6软件问题报告197

13.4软件测试报告常见问题198

第14章软件回归测试方案200

14.1软件回归测试方案的编写要求201

14.2软件回归测试方案的内容203

14.3软件回归测试方案编写示例206

14.3.1文档概述206

14.3.2回归测试策略206

14.3.3软件更动影响域分析207

14.4软件回归测试方案的常见问题208

第五篇软件使用文档

第15章软件产品规格说明211

15.1软件产品规格说明的编写要求211

15.2软件产品规格说明的内容211

15.3软件产品规格说明编写示例213

15.3.1可执行软件213

15.3.2源文件214

15.3.3“已建成”软件设计217

15.3.4计算机硬件资源使用218

15.4软件产品规格说明的常见问题218

第16章软件版本说明220

16.1软件版本说明的编写要求220

16.2软件版本说明的内容220

16.3软件版本说明编写示例222

16.3.1发布的材料清单222

16.3.2软件内容清单222

16.3.3更改说明223

16.3.4适应性数据224

16.3.5有关的文档224

16.3.6安装说明224

16.3.7可能的问题和已知的错误224

16.4软件版本说明的常见问题225

第17章软件用户手册226

17.1软件用户手册的编写要求226

17.2软件用户手册的内容227

17.3软件用户手册编写示例229

17.3.1安装和设置229

17.3.2处理规程230

17.3.3错误、故障和紧急情况下的恢复233

17.4软件用户手册的常见问题234

第六篇软件项目管理文档

第18章软件开发计划243

18.1软件开发计划编写要求244

18.2软件开发计划内容244

18.3软件开发计划示例247

18.3.1环境资源247

18.3.2软件开发模型249

18.3.3软件开发标准251

18.3.4项目估计252

18.3.5进度计划255

18.3.6关键依赖关系258

18.3.7风险管理259

18.3.8利益相关方管理259

18.3.9知识和技能获取计划260

18.3.10数据管理计划261

18.3.11需求管理计划263

18.3.12项目监控计划265

18.3.13用户交付要求266

18.4软件开发计划常见问题267

第19章软件配置管理计划268

19.1软件配置管理计划编写要求269

19.2软件配置管理计划内容270

19.3软件配置管理计划示例272

19.3.1基线划分与配置标识272

19.3.2配置控制276

19.3.3配置状态报告277

19.3.4配置审核279

19.4软件配置管理计划常见问题280

第20章软件质量保证计划281

20.1软件质量保证计划的编写要求282

20.2软件质量保证计划的内容283

20.3软件质量保证计划编写示例285

20.3.1与其他文档的关系285

20.3.2组织与人员285

20.3.3资源286

20.3.4审核依据287

20.3.5过程评价活动287

20.3.6产品评价活动288

20.3.7质量保证进度290

20.3.8过程检查准则292

20.3.9产品检查准则292

20.4软件质量保证计划的常见问题293

第21章软件研制总结报告295

21.1软件研制总结报告的编写要求296

21.2软件研制总结报告的内容297

21.2.1软件研制总结报告模板297

21.2.2软件阶段/里程碑总结报告模板301

21.3软件研制总结报告编写示例303

21.3.1设计原则和指导思想303

21.3.2软件开发工作综述303

21.3.3软件管理工作综述306

21.4软件研制总结报告的常见问题311

参考文献313