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

软件文档编写PDF格式电子书版下载

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

第1章 软件工程标准化与软件文档1

1.1 软件生存周期与软件文档1

1.2 软件文档的作用3

1.3 软件文档分类4

1.3.1 开发文档4

1.3.2 产品文档5

1.3.3 管理文档6

1.4 软件工程标准化6

1.4.1 软件工程标准化的意义7

1.4.2 软件工程标准的层次7

1.4.3 中国的软件标准8

1.4.4 五种常见的国际软件标准10

1.5 软件文档编写要求18

1.5.1 软件文档的编写原则18

1.5.2 文档编写的灵活性19

1.5.3 制定文档编写策略20

1.5.4 建立企业的文档标准21

1.5.5 制订文档编写计划22

1.5.6 建立文档管理规程23

1.5.7 软件文档的质量要求29

1.6 项目开发的文档化30

本章小结31

习题31

第2章 CASE工具与软件文档编写32

2.1 CASE概述32

2.2 CASE支持下的软件建模和文档编写工具33

2.2.1 Process Analyst和Data Architect33

2.2.2 SoDA自动化文档设计和生成36

2.2.3 PlayCASE54

本章小结55

习题55

第3章 可行性研究报告56

3.1 可行性研究概述56

3.1.1 可行性研究的任务56

3.1.2 可行性研究的步骤57

3.2 可行性研究报告的内容要求与编写指南58

3.2.1 可行性研究报告的引言60

3.2.2 可行性研究的前提60

3.2.3 对现有系统的分析62

3.2.4 对所建议系统的分析63

3.2.5 可行性分析65

3.2.6 可行性分析结论67

3.3 可行性研究报告编写示例68

本章小节77

习题77

实训177

第4章 基于结构化方法的软件文档79

4.1 软件需求规格说明书80

4.1.1 需求分析概述80

4.1.2 软件需求规格说明书的目的和编写要求82

4.1.3 软件需求规格说明书的内容要求与编写指南86

4.1.4 软件需求规格说明书不例100

4.2 概要设计说明书117

4.2.1 概要设计概述117

4.2.2 概要设计说明书的内容要求与编写指南119

4.2.3 概要设计说明书示例125

4.3 详细设计说明书136

4.3.1 详细设计概述136

4.3.2 详细设计说明书的内容要求和编写指南137

4.3.3 详细设计说明书示例140

本章小结145

习题145

实训2145

第5章 基于面向对象方法的软件需求规格说明书147

5.1 面向对象的软件需求分析概述147

5.2 软件需求规格说明书的内容要求与编写指南149

5.2.1 引言152

5.2.2 项目概述153

5.2.3 需求规定153

5.3 用例说明书的内容及编写要点155

5.4 基于面向对象方法的软件需求规格说明书示例157

本章小结171

习题171

实训3171

第6章 基于面向对象方法的软件设计说明书172

6.1 面向对象软件设计概述172

6.2 面向对象的软件设计说明书的内容要求和编写指南172

6.2.1 类报告173

6.2.2 用例实现报告174

6.2.3 设计模型报告174

6.3 面向对象设计文档的编写示例175

本章小结191

实训4191

第7章 程序代码的文档化192

7.1 程序代码规范192

7.2 Doxygen应用基础194

7.2.1 安装Doxygen195

7.2.2 设置项目的Doxygen配置文件模板195

7.2.3 编写正确格式的注释197

7.2.4 制作说明文件200

7.2.5 Doxygen使用步骤及范例200

本章小结203

习题203

实训5203

第8章 面向对象测试文档204

8.1 面向对象测试概述204

8.1.1 面向对象测试的具体任务204

8.1.2 面向对象测试的步骤205

8.2 面向对象测试文档206

8.2.1 测试计划206

8.2.2 测试用例208

8.2.3 测试报告209

8.3 面向对象测试文档的内容要求和编写指南210

8.3.1 引言211

8.3.2 项目背景212

8.3.3 质量目标214

8.3.4 测试资源215

8.3.5 测试策略216

8.3.6 测试计划218

本章小结219

习题219

实训6219

参考文献220