《如何写好计算机软件文档》求取 ⇩

第一章 软件文档在软件开发中的地位和作用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