软件文档写作教程PDF电子书下载

第1章 绪论 1

1.1 软件文档的意义 1

1.2 软件文档的作用 2

1.3 软件文档的分类 3

1.4 软件文档必备的条件 6

1.5 软件文档的管理 8

本章小结 12

参考文献 12

第2章 软件文档的写作规范 13

2.1 项目立项阶段文档的写作规范 13

2.2 需求分析书的写作规范 27

2.3 概要设计书的写作规范 31

2.4 详细设计书的写作规范 36

2.5 项目结束阶段文档的写作规范 39

本章小结 47

参考文献 47

习题 47

第3章 软件项目立项阶段文档写作案例分析——某市轨道交通突发事件实时应急集成指挥系统案例分析 49

3.1 项目的目的和意义 49

3.2 国内外研究开发现状和发展趋势 51

3.3 项目现有工作基础 52

3.4 项目实施目标 54

3.5 主要研究开发内容 55

3.6 社会经济效益分析和风险分析 59

3.7 年度目标和年度实施计划 60

3.8 预期主要成果 61

本章小结 62

参考文献 62

习题 62

第4章 需求分析书案例分析一——研究生教务管理系统案例分析 64

4.1 引言 64

4.2 任务概述 67

4.3 需求规定 68

4.4 运行环境规定 77

本章小结 78

参考文献 78

习题 78

第5章 需求分析书案例分析二——奥运综合服务系统案例分析 80

5.1 系统概述 80

5.2 功能和非功能需求 82

5.3 数据需求 92

5.4 接口需求 94

5.5 环境需求 101

本章小结 103

参考文献 103

习题 104

第6章 需求分析书案例分析三——地铁综合信息查询系统案例分析 105

6.1 概述 106

6.2 系统需求 108

6.3 总体结构 116

6.4 用户培训 117

本章小结 117

参考文献 117

习题 118

第7章 概要设计书案例分析一——研究生教务管理系统案例分析 119

7.1 引言 119

7.2 总体设计 121

7.3 接口设计 126

7.4 运行设计 127

7.5 系统数据结构设计 128

7.6 系统出错处理设计 133

本章小结 134

参考文献 135

习题 135

第8章 概要设计书案例分析二——办公自动化系统案例分析 136

8.1 引言 136

8.2 概要设计 137

8.3 各子系统概要设计 140

8.4 接口设计 144

8.5 系统出错处理设计 144

本章小结 162

参考文献 162

习题 162

第9章 概要设计书案例分析三——某企业建筑业信息化系统案例分析 164

9.1 软件体系结构的确立 164

9.2 框架选型 166

9.3 软件开发模型选择 167

9.4 总体设计 170

9.5 数据库设计 172

本章小结 174

参考文献 174

习题 174

第10章 详细设计书案例分析一——研究生教务管理系统案例分析 176

10.1 引言 177

10.2 程序系统的结构 178

10.3 程序设计说明 179

10.4 算法 188

10.5 接口 191

10.6 存储分配 191

10.7 注释设计 191

10.8 限制条件 192

10.9 测试计划 193

本章小结 193

参考文献 193

习题 194

第11章 详细设计书案例分析二——中国教育信息化系统案例分析 195

11.1 案例分析 195

11.2 详细设计的工具 199

11.3 详细设计书的注意事项 201

11.4 详细设计的评审 202

本章小结 204

参考文献 204

习题 205

第12章 软件项目结束阶段文档写作案例分析——校园博客系统案例分析 206

12.1 测试概述 207

12.2 测试计划执行情况 208

12.3 测试总结 211

12.4 综合评价 214

本章小结 215

参考文献 215

习题 215

第13章 总结 216