实用软件文档写作

第1章 软件工程标准化与软件文档 1
1.1 软件工程标准 1
1.2 软件工程标准化的意义 3
1.3 软件工程标准的层次 3
1.4 中国的软件标准 5
1.5 ISO 9000-3标准 8
1.5.1 ISO 9000标准产生的背景 8
1.5.2 ISO 9000系列标准的内容 9
第2章 软件文档及其组成 16
2.1 软件文档的概念 16
2.2 软件文档的作用 16
2.3 软件文档的分类 18
2.4 软件文档与使用者的关系 20
2.5 软件文档编制与软件生存周期的关系 20
第3章 软件文档国家标准 23
3.1 计算机软件产品开发文档编制指南 23
3.1.1 软件文档的组成 23
3.1.2 各类文档的内容要求 25
3.2 计算机软件需求说明编制指南 35
3.2.1 软件需求文档的编制目标 35
3.2.2 软件需求文档的基本要求 36
3.2.3 软件需求标准适用范围 36
3.2.4 需求文档的编写大纲 37
3.2.5 需求文档的编制说明 41
3.3 计算机软件测试文档编制规范 46
3.3.1 标准的适用对象及范围 46
3.3.2 测试文档的内容 47
3.3.3 测试文档与测试过程 47
3.3.4 测试文档的结构 49
3.3.5 测试文档的编制 51
3.3.6 测试文档编制实例 51
3.4 软件文档管理指南 52
3.4.1 软件文档管理概述 52
3.4.2 软件文档与文档管理者 52
第4章 软件文档写作要求 54
4.1 软件文档的编写原则 54
4.2 文档编写的灵活性 55
4.3 制定文档的编写策略 57
4.4 建立文档的企业标准 58
4.5 制定文档的编制计划 59
4.6 建立文档的编制规程 60
4.7 软件文档的质量要求 66
4.8 软件文档的编写技巧 67
4.9 文档编写的实例 68
第5章 软件开发文档 71
5.1 可行性研究报告 71
5.1.1 可行性研究报告的内容 71
5.1.2 可行性研究报告的要求 72
5.1.3 可行性研究报告的描述方法 73
5.1.4 可行性研究报告的评审 74
5.2 软件需求文档 74
5.2.1 软件需求文档的特点 75
5.2.2 软件需求文档的内容 77
5.2.3 软件需求文档的编写要求 79
5.2.4 软件需求文档的表达方法 80
5.2.5 软件需求文档的注释 82
5.2.6 软件需求文档的表达重点 83
5.2.7 需求表达中的常见问题 83
5.3 概要设计文档 84
5.3.1 结构化表现形式 84
5.3.2 面向对象设计表现形式 88
5.4 详细设计文档 96
5.4.1 详细设计文档的内容 96
5.4.2 详细设计文档的描述方法 97
第6章 软件管理文档 102
6.1 管理文档概述 102
6.2 项目开发计划 103
6.2.1 项目开发计划书 103
6.2.2 工作分解结构 104
6.2.3 项目里程碑与阶段性文档 105
6.2.4 项目进度 106
6.2.5 运用图和表描述项目进度 107
6.2.6 风险管理 110
6.3 软件测试计划与测试报告 113
6.3.1 软件测试、软件检查与调试 114
6.3.2 测试的成本 115
6.3.3 测试的原则 116
6.3.4 软件测试过程 117
6.3.5 测试计划的导出与测试计划的结构 118
6.3.6 几种常见的测试用图表工具 119
6.3.7 设计软件测试 121
6.3.8 软件测试计划文档 133
6.3.9 软件测试报告 134
6.4 开发进度报告 136
6.4.1 项目状态报告类型 137
6.4.2 报告的主要内容 138
6.4.3 开发进度偏差 138
6.4.4 图形报告工具 139
6.4.5 成本进度控制描述 141
6.4.6 项目的变更 144
6.5 项目开发总结报告 146
第7章 软件用户文档 147
7.1 编写用户文档的基本要求 147
7.2 软件常用表示形式 148
7.2.1 容器模型 148
7.2.2 客户机/服务器模型 148
7.2.3 抽象机模型 148
7.2.4 接口描述 149
7.2.5 控制模型 150
7.2.6 数据流模型 151
7.2.7 状态机模型 152
7.2.8 数据模型 152
7.2.9 对象模型 154
7.3 用户手册 156
7.4 操作手册 157
7.5 维护修改文档 157
7.5.1 软件运行系统的结构 158
7.5.2 维护修改方案 159
7.5.3 维护过程与记载 159
7.5.4 维护修改建议 161
第8章 软件文档管理 163
8.1 软件文档的管理 163
8.2 软件文档的管理方式 165
8.3 软件文档的维护 167
8.4 动态文档管理 168
8.5 项目管理软件 169
8.5.1 项目管理软件的功能 169
8.5.2 常见的项目管理软件 171
附录A 软件文档国家标准 173
附录A-1 软件产品开发文件编制指南（GB 8567-1988） 173
A-1.1 《可行性研究报告》编写参考指南 173
A-1.2 《项目开发计划》编写参考指南 178
A-1.3 《软件需求说明书》编写参考指南 180
A-1.4 《数据要求说明书》编写参考指南 181
A-1.5 《概要设计说明书》编写参考指南 183
A-1.6 《详细设计说明书》编写参考指南 185
A-1.7 《数据库设计说明书》编写参考指南 187
A-1.8 《用户手册》编写参考指南 188
A-1.9 《操作手册》编写参考指南 191
A-1.10 《模块开发卷宗》编写参考指南 193
A-1.11 《测试计划》编写参考指南 194
A-1.12 《测试分析报告》编写参考指南 195
A-1.13 《开发进度月报》编写参考指南 197
A-1.14 《开发总结报告》编写参考指南 198
附录A-2 计算机软件测试文件编制规范（GB 9386-1988）《软件测试文件》
编写参考指南 200
附录B 高评委专家库信息管理系统文档编制 206
附录C 银河侦探游戏软件文档编制 227
参考文献 260