描述
开 本: 16开纸 张: 胶版纸包 装: 平装-胶订是否套装: 否国际标准书号ISBN: 9787121316685
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
前 言
众所周知,软件文档是整个软件开发工作的基础,现代工程化的软件开发离不开软件文档。软件文档体系的建立与软件开发阶段密切相关,是软件开发整个生命周期中必不可少的一部分,软件生命周期始于软件文档,软件文档贯穿着整个软件生命周期。
作者从事软件工程的教学和研究已有十多年的历史,从长期的工作经验中发现,无论是相关专业的学生还是研究开发人员,对软件文档的写作都越来越重视,但对软件文档的写作规范知之甚少,国内有关软件文档写作的教材也比较少,而且缺乏实际案例的分析。软件文档写作是一门实践性比较强的课程,必须结合实际的软件开发案例进行教学。我们在总结多年的教学和研究经验的基础上,参考国内外版本的教材和论文,结合作者多年来跟踪国际上相关领域的研发方向的成果,编写了本书。
本书不同于一般的软件文档写作教材,书中不仅讲述软件文档写作的基本内容和方法,而且根据软件工程领域的发展,结合典型开发案例,力求系统地描述可行性研究报告、项目建议书、招投标文件、需求分析书、概要设计书、详细设计书、项目验收报告和项目总结报告等文档的写作规范与技巧,并以数个典型的软件系统开发项目为案例,重点讲述项目建议、需求分析书、概要设计书、详细设计书和项目验收总结报告的内容、要求、写作技巧与注意事项,指导学生如何撰写软件开发过程中的相关文档。
本书包括以下13章。
? 第1章是绪论。主要介绍软件文档的意义、作用和分类等相关知识。
? 第2章介绍软件文档的写作规范。主要内容包括可行性研究报告,项目建议书,招投标文件的写作规范,需求分析书的写作规范,概要设计书的写作规范,详细设计书的写作规范,项目验收总结报告写作规范。
? 第3章通过典型案例—某市轨道交通突发事件实时应急集成指挥系统开发过程中的软件文档,讲述软件项目立项阶段项目建议书的内容、要求、写作技巧和注意事项。
? 第4章通过典型案例—研究生教务管理系统开发过程中的软件文档,讲述需求分析书的内容、要求、写作技巧和注意事项。
? 第5章通过典型案例—奥运综合服务系统开发过程中的软件文档,进一步讲述需求分析书的内容、要求、写作技巧和注意事项。
? 第6章通过典型案例—地铁综合信息查询系统开发过程中的软件文档,讲述企业实际项目的需求设计书的内容、要求、写作技巧和注意事项。
? 第7章通过典型案例—研究生教务管理系统开发过程中的软件文档,讲述概要设计书的内容、要求、写作技巧和注意事项。
? 第8章通过典型案例—办公自动化系统开发过程中的软件文档,进一步讲述概要设计书的内容、要求、写作技巧和注意事项。
? 第9章通过典型案例—某企业建筑业信息化系统开发过程中的软件文档,讲述企业实际项目的概要设计书的内容、要求、写作技巧和注意事项。
? 第10章通过典型案例—研究生教务管理系统开发过程中的软件文档,讲述详细设计书的内容、要求、写作技巧和注意事项。
? 第11章通过典型案例—中国教育信息化系统开发过程中的软件文档,讲述企业实际项目的详细设计书的内容、要求、写作技巧和注意事项。
? 第12章通过典型案例—校园博客系统开发过程中的软件文档,讲述软件项目结束阶段项目验收总结报告的内容、要求、写作技巧和注意事项。
? 第13章总结全书的主要内容。
本书在浅显易懂的理论介绍之后,将重点放在典型案例分析上,通过具体形象的案例去理解有关理论。本书可作为软件工程、计算机科学与技术等专业本科生和研究生的参考书,也可作为相关研究开发人员的参考书和工具书。
由于笔者学识有限,本书难免有不足之处,恳请各位专家读者不吝赐教。
评论
还没有评论。