实用软件文档写作【2025|PDF下载-Epub版本|mobi电子书|kindle百度云盘下载】

实用软件文档写作PDF格式电子书版下载

注意：本站所有压缩包均有解压码： 点击下载压缩包解压工具

第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.1.1 软件文档的组成23

3.1 计算机软件产品开发文档编制指南23

第3章 软件文档国家标准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.1 软件文档管理概述52

3.4.2 软件文档与文档管理者52

3.4 软件文档管理指南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.2 软件需求文档74

5.1.4 可行性研究报告的评审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.1 结构化表现形式84

5.3 概要设计文档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.3 开发进度偏差138

6.4.2 报告的主要内容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.5 维护修改文档157

7.4 操作手册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-1 软件产品开发文件编制指南（GB 8567—1988）173

A-1.1 《可行性研究报告》编写参考指南173

附录A 软件文档国家标准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