软件文档写作教程

图书标准信息

• 作者 马平
• 出版社 电子工业出版社
• 出版时间 2017-07
• 版次 1
• ISBN 9787121316685
• 定价 39.00元
• 装帧 其他
• 开本 16开
• 纸张 胶版纸
• 页数 219页
• 字数 99999千字

【内容简介】

本书不同于一般的软件文档写作教材，不仅讲述软件文档写作的基本内容和方法，而且根据软件工程领域的*发展，结合典型开发案例，力求系统地描述可行性研究报告、项目建议书、投标文件、需求分析书、概要设计书、详细设计书、项目验收报告和项目总结报告等文档的写作规范和技巧。以典型的软件系统开发项目为案例，重点讲述开发过程中形成的三大文档，指导学生如何书写软件开发过程中的相关文档。

【作者简介】

马平, 北京航空航天大学软件学院教授, 长期从事软件工程领域的教学与研究工作, 著有等作品, 发表论文多篇.

【目录】

第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

习题48

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

集成指挥系统案例分析49

3.1  项目的目的和意义49

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

3.3  项目现有工作基础52

3.4  项目实施目标54

3.5  主要研究开发内容55

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

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

3.8  预期主要成果62

本章小结62

参考文献62

习题63

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

4.1  引言64

4.2  任务概述67

4.3  需求规定68

4.4  运行环境规定76

本章小结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  测试总结210

12.4  综合评价213

本章小结214

参考文献214

习题214

第13章  总结216