第一章 软件文档在软件开发中的地位和作用 1
1.1 什么是软件危机？ 1
1.2 软件工程的基本概念 3
1.2.1 可行性研究与计划 5
1.2.2 需求分析 7
1.2.3 软件设计 10
1.2.4 实现 12
1.2.5 测试 14
1.2.6 使用和维护 16
1.3 软件文档在软件工程中的地位和作用 18
1.3.1 文档的地位和作用 18
1.3.2 对文档的基本要求 20
1.4.1 以文字叙述为主的各种软件开发文档 21
1.4 软件文档的种类 21
1.4.2 伴随各类文字文档的图表特点 22
2.1.1 掌握软件开发的详细内容 25
第二章 软件文档的编写步骤 26
2.1 准备工作 26
2.1.2 了解软件文档使用者的要求 27
2.2 确定写作内容 30
2.2.1 确定文档的种类 30
2.2.2 文档内容的组织 31
2.2.3 建立编写软件文档的有关约定 34
2.3 编写定稿 36
2.3.1 编写 36
2.3.2 修改 37
2.3.3 定稿 37
2.4.1 更新 38
2.4 更新完善 38
2.4.2 完善 39
第三章 软件文档的主要内容及写作要求 41
3.1 可行性研究报告的主要内容及写作要求 41
3.1.1 编写目的 41
3.1.2 主要内容及写作要求 41
3.2 项目开发计划的主要内容及写作要求 51
3.2.1 编写目的 51
3.2.2 主要内容及写作要求 52
3.3 软件需求说明书的主要内容及写作要求 54
3.3.1 编写目的 54
3.3.2 主要内容及写作要求 54
3.4.1 编写目的 60
3.4.2 主要内容及写作要求 60
3.4 数据要求说明书的主要内容及写作要求 60
3.5 概要设计说明书的主要内容及写作要求 63
3.5.1 编写目的 63
3.5.2 主要内容及写作要求 64
3.6 详细设计说明书的主要内容及写作要求 67
3.6.1 编写目的 67
3.6.1 主要内容及写作要求 67
3.7 数据库设计说明书的主要内容及写作要求 69
3.7.1 编写目的 69
3.7.2 主要内容及写作要求 70
3.8 用户手册的主要内容及写作要求 73
3.8.1 编写目的 73
3.8.2 主要内容及写作要求 73
3.9.2 主要内容及写作要求 77
3.9.1 编写目的 77
3.9 操作手册的主要内容及写作要求 78
3.10 模块开发卷宗的主要内容及写作要求 81
3.10.1 编写目的 81
3.10.2 主要内容及写作要求 81
3.11 测试计划的主要内容及写作要求 84
3.11.1 编写目的 85
3.11.2 主要内容及写作要求 85
3.12 测试分析报告的主要内容及写作要求 89
3.12.1 编写目的 89
3.12.2 主要内容及写作要求 89
3.13 开发进度月(季)报的主要内容及写作要求 91
3.13.1 编写目的 91
3.13.2 主要内容及写作要求 91
3.14.1 编写目的 94
3.14 项目开发结束报告的主要内容及写作要求 94
3.14.2 主要内容及写作要求 95
第四章 软件开发中的图表表达方法 98
4.1 图的作用及约定 98
4.1.1 图的作用 98
4.1.2 特殊符号 99
4.1.3 绘图约定 108
4.2 图形种类及应用 113
4.2.1 图形种类 113
4.2.2 各种符号在各类图中的应用 115
4.2.3 不同种类和层次的图在文档中的使用 120
4.3 表的制作要求 122
4.3.1 表的作用 122
4.3.2 制表要求 122
4.3.3 表的应用及分类 124
5.1 做好准备 127
5.1.1 深入理解系统和用户 127
第五章 如何写好计算机软件文档 127
5.1.2 明确写作目的 129
5.1.3 确定文档组织方式 131
5.2 讲究文风 133
5.2.1 语言简洁 133
5.2.2 读者观点 134
5.2.3 尊重习惯 135
5.3 注重表达 135
5.3.1 图表 136
5.3.2 符号 136
5.3.3 引例 137
5.4.1 软件文档编写过程管理 138
5.4 加强文档编写使用的组织管理 138
5.4.2 软件文档使用的管理 141
5.5 值得注意的几个问题 142
5.5.1 文档的整体结构 142
5.5.2 文档的一致性 143
5.5.3 文档的可用性 144
5.5.4 文档的可维护性 145
5.5.5 文档的及时性 146
5.5.6 文档的评审测试 146
5.5.7 文档的使用培训 147
5.5.8 文档编写自动化 147
附录A 文档封面内容和格式 149
附录B 文档目录格式 150
附图 151