第1章 软件文档概述 1
1.1 为什么需要软件文档 1
1.2 软件文档的定义 3
1.3 软件文档的地位和作用 4
1.4 软件文档的分类 7
1.5 软件文档的使用 9
1.6 软件编档与软件生命周期 12
讨论题 15
第2章 软件工程标准化 17
2.1 软件工程标准化 17
2.1.1 什么是“标准” 17
2.1.2 软件工程标准化 19
2.1.3 软件工程标准化的意义 20
2.2 软件工程标准分类 21
2.2.1 按标准的类型划分 21
2.2.2 按标准的范围划分 21
2.3 中国国家软件工程标准 23
2.3.1 基础标准 24
2.3.2 开发（包括维护）标准 26
2.3.3 文档标准 27
2.3.4 管理标准 28
2.4 软件工程标准的层次 30
2.4.1 国际标准 30
2.4.2 国家标准 31
2.4.3 行业标准 31
2.4.4 企业规范 32
2.4.5 项目规范 32
2.5 软件工程标准的制定与推行 32
2.6 在开发机构中推行软件工程标准 33
2.7 ISO 9000国际标准 34
2.7.1 ISO 9000标准概述 34
2.7.2 ISO 9000标准的特点 35
2.7.3 ISO 9000标准的内容 36
2.7.4 ISO 9000系列标准的主导思想 38
2.7.5 质量保证标准之间及其与质量管理标准的关系 39
2.7.6 ISO 9000-3及其对软件质量保证的要求 39
2.8 软件工程标准化与软件文档的关系 46
讨论题 47
第3章 软件视图和文档风格 48
3.1 软件视图的概念和类型 48
3.2 软件视图类型 51
3.3 软件文档风格的概念 51
3.4 软件文档风格指导 52
3.5 模块视图及文档风格 56
3.5.1 模块视图类型 56
3.5.2 模块视图类型的文档风格 62
3.5.3 模块视图类型风格编档评估 75
3.6 组件和连接器（C＆C）视图及文档风格 75
3.6.1 C＆C视图类型 75
3.6.2 C＆C类型的文档风格 85
3.6.3 C＆C视图类型风格编档评估 92
3.7 分配视图类型及文档风格 93
3.7.1 分配视图类型 93
3.7.2 分配视图类型的文档风格 94
3.7.3 分配视图类型风格编档评估 101
讨论题 101
第4章 软件文档表达 102
4.1 软件文档的编制原则 104
4.2 合理文档的7条规则 106
4.3 文档表达的载体 111
4.3.1 纸质文档 111
4.3.2 自动文档 111
4.4 软件文档的涉众 112
4.4.1 项目经理 113
4.4.2 分析人员 114
4.4.3 开发人员 114
4.4.4 基础结构支持人员 115
4.4.5 应用程序开发人员 115
4.4.6 测试人员和集成人员 116
4.4.7 维护人员 116
4.4.8 客户 117
4.4.9 最终用户 117
4.4.10 新的涉众 118
4.4.11 未来系统设计师 118
4.4.12 其他系统的设计人员 119
4.5 软件文档内容组织 120
4.5.1 确定可能的组织类型 120
4.5.2 确定所有的组织方式 123
4.5.3 摘要 123
4.5.4 建立初步的文档组织内容表 123
4.5.5 组织文档的要点 126
4.6 选择文档表达方法 126
4.6.1 选择文档视图表达方式 126
4.6.2 选择文档写作表达方式 128
4.7 国际化软件开发编档 133
4.7.1 国际化软件开发编档的基本要求 133
4.7.2 国际化软件开发编档的基本准则 134
4.8 软件本地化工程文档处理 135
4.8.1 软件本地化工程的目的 135
4.8.2 软件本地化工程及文档处理的内容 136
4.8.3 软件本地化工程及文档处理的流程 136
4.8.4 软件本地化工程文档处理的工具 137
4.8.5 软件本地化工程文档处理的人员 138
第5章 软件编档的要求 140
5.1 有关系统开发生命周期文档的讨论 140
5.2 软件编档的灵活性 142
5.2.1 编制文档的种类 143
5.2.2 文档的详细程度 143
5.2.3 文档的扩展 143
5.2.4 章节的展开与缩并 144
5.2.5 程序设计表达 145
5.2.6 文档内容表达 145
5.2.7 文档的其他种类 145
5.3 制定编档策略 145
5.4 制定编档计划 147
5.5 建立编档规范 148
5.5.1 软件编档规范的制定及用途 148
5.5.2 软件编档规范的结构 149
5.5.3 软件编档规范的应用 149
5.6 软件编档步骤 150
5.6.1 制定软件编档计划 150
5.6.2 文档编制 150
5.6.3 文档编号 152
5.6.4 文档评审 152
5.6.5 文档签署 155
5.6.6 文档归档与保管 157
5.6.7 文档维护 157
5.7 软件编档的质量要求 157
5.7.1 影响软件编档质量的主要问题 157
5.7.2 从质量保证的角度对编档提出的要求 158
5.7.3 支持软件编档的措施 160
5.8 软件编档技巧 163
5.8.1 使用简洁的表达 164
5.8.2 采用主动语态动词 168
5.8.3 使用有效的语法规则和标点 170
5.9 确定软件编档种类的两个实例 173
第6章 软件开发文档 178
6.1 开发文档概述 178
6.1.1 软件开发文档的种类 178
6.1.2 软件项目生命周期开发文档的编制 179
6.2 可行性分析报告 181
6.2.1 项目可行性分析的任务和要求 181
6.2.2 项目可行性分析的内容 182
6.2.3 可行性分析报告的主要描述方法 185
6.2.4 可行性分析报告的评审 191
6.2.5 项目开发计划 191
6.3 软件需求文档 192
6.3.1 软件需求编档的任务和要求 193
6.3.2 软件需求编档的原则 195
6.3.3 软件需求编档的内容 195
6.3.4 软件需求编档的主要方法 200
6.3.5 软件需求编档的重点 208
6.3.6 软件需求编档的常见问题 209
6.3.7 软件需求文档的评审 210
6.4 软件概要设计文档 216
6.4.1 结构化设计编档 217
6.4.2 面向对象设计编档 220
6.4.3 概要设计编档的内容 225
6.5 软件详细设计文档 228
6.5.1 详细设计编档方法 228
6.5.2 详细设计编档的内容 233
第7章 软件管理文档 236
7.1 管理文档概述 236
7.2 项目开发计划 238
7.2.1 项目开发计划书的内容 239
7.2.2 项目工作分解结构 240
7.2.3 项目里程碑和阶段性文档 241
7.2.4 项目进度估算和计划 243
7.2.5 项目计划的图表描述方法 245
7.2.6 项目风险管理 249
7.3 软件测试文档 256
7.3.1 软件和软件文档的测试 257
7.3.2 软件测试计划的导出和内容 258
7.3.3 软件测试编档的几种常用图表工具 259
7.3.4 软件测试方法设计 261
7.3.5 软件测试计划 269
7.3.6 软件测试分析报告 272
7.4 项目开发进度报告 275
7.4.1 项目状态报告的类型 276
7.4.2 开发进度偏差 277
7.4.3 报告的图形工具 277
7.4.4 成本进度控制描述 280
7.4.5 项目进度报告的主要内容 282
7.4.6 项目变更报告 283
7.5 项目开发总结报告 284
第8章 软件用户文档 285
8.1 用户文档编制的基本要求 285
8.2 软件常用表示形式 286
8.2.1 系统部件模型的文档表示 286
8.2.2 对话设计的文档表示 293
8.3 用户手册 296
8.4 操作手册 298
8.4.1 引言 298
8.4.2 操作原理 298
8.4.3 操作说明 298
8.4.4 注意事项 298
8.4.5 附录 299
8.5 软件维护文档 299
8.5.1 软件运行系统的结构 299
8.5.2 软件维护方案 300
8.5.3 软件维护与变更 301
8.5.4 软件维护建议 302
第9章 软件文档发行 304
9.1 完善文档 304
9.1.1 核对和编辑文档 304
9.1.2 使用图表 306
9.1.3 使用例子 308
9.2 文档定稿 316
9.2.1 文档目录定稿 316
9.2.2 文档序言定稿 318
9.2.3 文档正文定稿 320
9.2.4 文档附录定稿 323
9.2.5 文档最后定稿 326
9.3 文档测试 327
9.3.1 提交读者测试 327
9.3.2 编档者自行测试 328
9.4 文档评审 330
9.4.1 确定评审人 330
9.4.2 要有多层次的评审人 331
9.4.3 确定评审后修改的步骤 331
9.4.4 修改的部分仍然需要送审 331
9.4.5 准备好审稿者的签名表 331
9.4.6 定出审稿的步骤 332
9.4.7 评审文档的要点 333
9.5 制作软件文档包 333
9.5.1 采用一个文档还是若干文档 333
9.5.2 文档包组织模板 335
9.5.3 如何组织文档才能满足涉众需要 337
9.5.4 文档包的实施和支持 338
9.5.5 文档包制作总结评估 340
9.6 发行文档 340
9.6.1 确定文档的装帧形式 340
9.6.2 将文档分发给涉众 341
9.7 培训与用户支持 343
9.7.1 制定培训计划和开展培训活动 343
9.7.2 进行中的培训和用户支持活动 345
9.8 更新文档 346
9.8.1 制定文档更新步骤 346
9.8.2 如何确定文档是否更新 348
第10章 软件编档管理 351
10.1 软件编档管理及方法 351
10.1.1 软件编档的管理 352
10.1.2 文档的分类与标识 352
10.1.3 软件文档的管理和控制 353
10.2 软件文档维护 353
10.2.1 软件文档维护的方法 353
10.2.2 软件文档维护的管理 355
10.3 动态文档管理 356
10.4 文档质量评审 357
10.4.1 建立明确的文档质量目标 357
10.4.2 使用提高文档质量的技术和工具 358
10.4.3 进行明确的质量保证评审 359
10.5 软件编档的风险及防范 362
10.6 软件编档的组织管理 364
10.6.1 制定文档编档策略 364
10.6.2 制定文档编档标准和规范 365
10.6.3 制定文档编档计划 367
10.6.4 制定文档编档规程 368
10.6.5 软件文档的管理方式 368
10.7 项目管理软件 369
附录A 软件产品开发文件编制的国家标准及模板 370
附录B 标准名称缩写列表 404
附录C 案例——移动BOSS系统技术文档（部分） 411
参考文献 456