第1章 软件工程基础 1
1.1 软件与软件工程 1
1.1.1 软件定义与软件特点 1
1.1.2 软件危机与软件工程 2
1.2 软件过程 4
1.2.1 瀑布模型对应的软件过程 5
1.2.2 以架构为核心的软件过程 6
1.3 软件过程中的文档 7
1.3.1 软件文档 7
1.3.2 撰写软件文档的目的与作用 8
1.3.3 软件文档的范围及分类 9
1.3.4 项目开发与文档的关系 11
1.3.5 软件过程角色与文档的关系 12
1.3.6 软件过程中的文档编制 13
1.3.7 撰写软件文档应考虑的因素 14
1.3.8 软件文档的管理 16
第2章 项目规划类文档写作 18
2.1 项目立项过程 18
2.2 商业计划书 19
2.2.1 商业计划书写作要求 19
2.2.2 商业计划书内容框架 20
2.3 可行性研究报告 22
2.3.1 可行性研究报告写作要求 22
2.3.2 可行性研究报告内容框架 23
2.4 项目方案书 23
2.4.1 项目方案书写作要求 23
2.4.2 项目方案书内容框架 24
2.5 项目开发计划 25
2.5.1 项目开发计划写作要求 25
2.5.2 项目开发计划内容框架 26
第3章 需求类文档写作 30
3.1 需求概述 30
3.2 软件需求的分类 31
3.3 需求过程 32
3.3.1 需求分析 32
3.3.2 需求过程的管理 34
3.3.3 需求获取的流程 35
3.3.4 需求管理的角色 36
3.4 需求说明书的撰写要求 37
3.4.1 需求文档的文字叙述要求 37
3.4.2 对用例说明的要求 38
3.4.3 非功能需求的说明要求 38
3.5 需求说明书内容框架 39
3.6 需求原型工具Axure 39
第4章 设计类文档写作 41
4.1 软件设计过程 41
4.2 软件架构设计 45
4.2.1 架构的概念 45
4.2.2 以架构为中心的迭代开发周期模型 46
4.2.3 领域建模 47
4.2.4 非功能需求驱动的架构设计 49
4.3 软件架构文档 53
4.3.1 软件架构文档写作要求 53
4.3.2 软件架构文档内容框架 54
4.4 概要设计说明书 56
4.4.1 概要设计说明书写作要求 56
4.4.2 概要设计说明书内容框架 58
4.5 详细设计说明书 60
4.5.1 详细设计说明书写作要求 60
4.5.2 详细设计说明书内容框架 64
4.6 数据库设计说明书 65
4.6.1 数据库设计的步骤 65
4.6.2 数据库设计说明书内容框架 66
4.7 用户界面设计文档 68
第5章 测试类文档写作 70
5.1 测试过程 70
5.1.1 测试概述 70
5.1.2 集成测试过程 72
5.1.3 系统测试过程 73
5.2 测试用例的撰写 80
5.2.1 测试用例写作要求 80
5.2.2 测试用例内容框架 81
5.3 测试计划 85
5.4 测试分析报告 87
第6章 项目结束类文档写作 89
6.1 部署过程 89
6.2 用户培训计划 90
6.3 开发组织内部的培训课程 93
6.4 用户手册 96
6.4.1 用户手册要求 96
6.4.2 用户手册内容框架 96
6.5 产品手册要求 99
6.6 项目总结 100
6.6.1 项目总结要求 100
6.6.2 项目总结报告内容框架 100
第7章 项目管理过程类文档写作 102
7.1 项目管理过程 102
7.2 项目风险管理 105
7.3 时间进度管理 107
7.4 项目估算管理 110
7.5 项目管理过程文档 112
第8章 质量保证文档写作 114
8.1 软件质量保证定义 114
8.2 软件质量保证管理 116
8.2.1 SQA过程 116
8.2.2 SQA偏差过程 119
第9章 软件文档配置管理 121
9.1 软件配置管理过程 121
9.1.1 软件配置管理出现的背景 122
9.1.2 软件配置管理发展现状 123
9.1.3 软件配置管理的目的 123
9.1.4 软件配置管理的基本活动 124
9.2 配置管理过程规范 127
9.2.1 配置管理计划 127
9.2.2 实施配置管理 128
9.3 配置管理工具 128
9.4 软件文档的配置管理方案 130
9.4.1 软件配置管理环境的设置 130
9.4.2 软件配置管理机制的组成和建立 131
9.4.3 软件配置管理活动的实施流程 132
9.4.4 软件配置管理基本任务的相关规范 133
9.4.5 配置管理的标识规范 142
9.4.6 配置管理的建议 144
9.5 需求文档变更的管理 144
9.5.1 需求变更的原因 144
9.5.2 需求变更的处理流程 146
第10章 企业软件文档的管理 148
10.1 企业软件文档分类 148
10.2 企业软件文档管理要求 149
10.3 企业软件文档管理流程 149
10.4 项目文档的管理 150
附录A 文档封面模板 151
附录B 项目规划期文档模板 153
B.1 可行性研究报告模板 153
B.2 项目方案书模板 158
附录C 需求类文档模板 161
C.1 需求调研报告 161
C.2 需求规格说明书 162
C.3 用例使用场景模版与实例 164
C.4 用例描述模板 167
C.5 需求评审报告 168
C.6 需求分析报告检查表 171
附录D 文档设计模板 172
D.1 软件架构设计说明书 172
D.2 概要设计说明书 174
D.2.1 模板1 174
D.2.2 模板2 177
D.3 详细设计说明书 178
D.3.1 模板1 178
D.3.2 模板2 180
D.4 数据库设计说明书 180
附录E 设计文档模板 182
E.1 软件配置管理规范 182
E.2 软件修改报告 186
附录F 单元测试报告文档模板 187
附录G 项目管理文档模板 188
G.1 风险列表 188
G.2 周报 191
附录H 质量保证文档模板 193
H.1 质量保证计划 193
H.2 SQA汇总报告 195
H.3 SQA每周报告 196
H.4 SQA偏差报告 197
附录I 软件文档评分标准 198
参考文献 200