《软件工程》实验指导.docx
《《软件工程》实验指导.docx》由会员分享，可在线阅读，更多相关《《软件工程》实验指导.docx（27页珍藏版）》请在冰豆网上搜索。
《软件工程》实验指导
《软件工程》
实验指导
苏州大学计算机学院陈建明
有关说明
软件项目的开发，按照其生命周期，主要经历问题定义、可行性分析、需求分析、系统概要设计、系统详细设计、编码、测试、验收与使用维护等阶段。
对设计工作者来说，每个阶段主要就是完成相应的文档。
这里有技术类文档，也有管理类文档。
《软件工程概论》课程的实验，主要是通过对一个简单项目的设计，了解其开发过程，并初步掌握各阶段主要文档的编制。
在本实验指导中，主要列出了软件开发过程中所需完成的十二个主要文档的内容组成和编制方法。
这十二个文档是：
1）可行性分析报告
2）立项报告
3）开发进度计划
4）需求分析报告
5）概要设计说明书
6）功能设计说明书
7）数据结构说明书
8）详细设计说明书
9）测试计划
10）功能测试说明书
11）用户手册
12）项目总结报告
一、可行性分析报告
1．引言
1.1编写目的
1.2开发背景
建议系统名称：
项目信息：
定义：
1.3参考资料：
2．可行性研究前提
2.1）基本要求
2.2）目标
2.3）条件限制
2.4）调研方式及评价方式
2.5）评价标准
3．对现有系统的分析
3.1）现有系统的流程
3.2）工作负荷
3.3）费用开支
3.4）人员结构
3.5）设备情况
3.6）局限性
4．所建议的系统
4.1）所建议的系统简介
4.2）建议系统使用的流程
4.3）针对原系统进行的改进
4.4）预期的影响
4.5）建议系统的局限性
4.6）技术上的可行性
5．可选的其它方案
6．投资及效益分析
6.1）支出（包括现有系统继续运行所需费用）
a）基本建设投资
b）其它一次性支出
c）非一次生支出
6.2）收益
a）一次性收益
b）非一次性收益
c）不可定量的收益
6.3）收益/投资比
6.4）投资回收期
6.5）敏感性分析
7．其它方面的可行性
8．结论
二、立项报告
1．引言
1.1）编写目的
1.2）系统简要信息
1.3）定义
1.4）参考资料
2．主要内容及基本要求
2.1）对项目的基本要求
2.2）此项目的主要目标
2.3）给出的条件、假定、限制
2.4）技术基础及相应的市场分析
2.5）对项目的评价方式及尺度
3．项目的设计及实现
3.1）流程
3.2）工作负荷
3.3）费用开支
3.4）人员结构
3.5）设备情况
3.6）局限性
4．运行设计
4.1）项目时间总体规划
4.2）进度分段标准
4.3）阶段考核方法
5．项目验收
5.1）项目验收方式
5.2）提交内容清单
5.3）后续工作情况
6．总结
三、开发进度计划
1．引言
1.1）编写目的
[]
1.2）背景
1.3）定义
1.4）参考资料
2．项目简介
2.1）项目组成立日期
2,2）项目内含模块简介
2.3）项目各模块技术分析
2.4）项目主要参于人员及职能
3．风险管理机制
3.1）对此项目的风险估计
3.2）相应的风险方案
3.3）进度中分配给风险部分的时间
3.4）风险时间的使用情况
4．计划进度与实际进度
4.1）立项
a）立项日期
b）项目启动日期
4.2）需求分析
a）需求分析开始日期
b）需求分析结束日期
4.3）概要设计
a）概要设计开始日期
b）概要设计完成日期
4.4）系统测试
a）系统测试开始日期
b）系统测试完成日期
4.5）系统交付
a）全部文档审核日期
b）项目交付时间
5．各模块开发计划与实际进度
5.1）模块一开发进度
a）模块名称
b）模块开发小组
c）模块设计开始日期
d）模块设计完成日期
e）详细设计开始日期
f）详细设计完成日期
g）模块文档审核日期
h）代码编写开始日期
i）代码编写完成日期
j）模块提交日期
6．进度图
7．其它
四、需求分析报告
1．引言
1.1）系统参考文献
1.2）整体描述
本系统名称为：
本系统由[任务提出者]提出，开发。
本系统将在[软件运行地点]运行，为提供服务。
1.3）软件项目
2．信息描述
2.1）信息内容表示
2.2）信息流
数据流：
控制流：
3．功能描述
3.1）功能划分
3.2）功能描述
a）处理说明
b）限制、局限
c）性能需求
d）设计约束
e）支撑图
3.3）控制描述
a）控制规约
b）设计规约
4．行为描述
4.1）系统状态
4.2）事件和动作
5．校验和校准
5.1）性能范围
5.2）基本测试方案
5.3）系统的期望目标
5.4）特殊的考虑
例：
因为软件最终运行环境是小形机，而测试环境是微机，故实际效能应比检测结果更好。
6．参考书目
7．附录
五、概要设计说明书
1．引言
1.1）编写目的
1.2）背景
本系统名称为：
本系统由提出，开发。
本系统将在[软件运行地点]运行，为提供服务。
1.3）定义
以下是本文中使用的部分专业词语和外文缩写的说明：
：
1.4）参考资料
本文使用的参考文件：
2．总体设计
2.1）需求规定
2.2）运行环境
2.3）基本设计概念和处理流程
2.4）结构
2.5）功能需求与程序的关系
2.6）人工处理过程
2.7）尚未解决的问题
3．接口设计
3.1）用户接口
3.2）外部接口
3.3）内部接口
4．运行设计
4.1）运行模块组合
4.2）运行控制
4.3）运行时间
5．系统数据结构设计
5.1）逻辑结构设计要点
5.2）物理结构设计要点
5.3）数据结构与程序的关系
6．系统出错处理设计
6.1）出错信息
6.2）补救措施
6.3）系统维护设计
7．附录
六、功能设计说明书
1．引言
1.1）编写目的
1.2）定义
1.3）参考资料
2．模块分析
2.1）模块名称
2.2）模块所要实现的功能
2.3）模块设计思路
2.4）模块使用数据的方式
2.5）进度计划
3．模块结构设计
3.1）模块元素列表
3.2）模块元素内部关系图
3.3）模块数据流程图
3.4）模块内部接口标准
3.5）模块对外接口标准
3.6）功能实现
4．功能测试方案
4.1）模块测试点详表
4.2）测试方案
4.3）测试标准
4.4）错误返馈机制
5．重要元素流程图
5.1）核心元素流程详图
5.2）重要元素流程简图
5.3）主要元素设计方针
6．内部错误处理机制
6.1）内部错误处理方案
6.2）内部错误处理能力
6.3）不准备处理的错误
7．附录
七、数据结构说明书
1．引言
1.1）编写目的
1.2）背景
1.3）定义
1.4）参考资料
2．数据分析
2.1）数据内容分析
2.2）数据频度分析
2.3）数据量分析
2.4）数据结构模型
3．数据关系分析
4．整体设计
4.1）采用的数据库
4.2）数据库名称
4.3）数据库说明
4.4）各种数据要求的实质
5．表格设计
5.1）表格列表
5.2）各表格内部设计
5.3）表格间关系
6．数据维护方案
6.1）日常维护
6.2）扩展方式
6.3）备份及恢复
6.4）其它
7．数据库结构图
八、详细设计说明书
1．引言
1.1）编写目的
1.2）背景
1.3）定义
1.4）参考资料
2．程序系统结构
3．元素索引表
4．程序设计
4.1）
a）程序描述
b）功能
c）性能
d）输入项
e）输出项
f）算法
g）流程逻辑
h）接口
i）存储分配
j）注释设计
k）限制条件
l）测试计划
m）尚未解决的问题
4.2）
……内容与格式同4.1
……同上，直至所有元素描述完毕
九、测试计划
１引言
编写目的：
提示：
说明编写这份文档的目的，指出预期的读者。
1.2背景
待开发的软件系统的名称：
本项目的任务提出者：
本项目的开发者：
本软件系统的用户：
运行该程序系统的计算中心：
1.3定义
提示:
列出本文件中用到的专门术语的定义和外文首字母组词的原词组
1.4参考资料
提示:
列出用得着的参考资料，如：
a.本项目的经核准的计划任务书或合同、上级机关的批文；
b.属于本项目的其他已发表的文件；
c.本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2.被测试的特性
规定测试项，描述作为本设计测试目标的特性和特性的组合，其它特性可以论及，但不必测试。
3.方法详述
将测试计划中规定的方法进行细化，包括要用的具体测试技术，规定分析测试结果的方法（如此较程序或人式观察）。
规定为选择测试髟例提供合理依据的一切分析结果。
例如：
可以说明容错的条例（如：
区别有效输入和无效输入的条件）。
归纳所有测试用例的共同属性，可以包括输入约束条件，共享环境的要求，对共享的特殊规程的要求及任何共享的测试用例间的依赖关系。
4.测试用例名称
列出与本设计有关的每一测试用例的名称和简要说明，某个特定的测试用例可能在多个测试设计说明中出现，列出与本测试设计说明有关的规程其简要说明。
5.特性通过准则
规定用于判别特性和特性组合是否通过测试的准则。
十、功能测试说明书
1．引言
1.1）编写目的
1.2）背景
1.3）定义
1.4）参考资料
2．模块测试环境
2.1）模块用于进行测试的环境
2.2）参于测试的人员
2.3）使用的测试方法
3．元素测试结果表
在《功能设计说明书》中归为
下表是本模块内所有元素最后一次的测试情况：
元素
说明
功能目标
测试时间
测试内容
评价
测试人员
4．内联测试结果表
下表是本模块内部分元素内部联接能功测试记录：
参于元素
环境
测试内容
测试日期
评价
测试人员
5．模块集成测试结果
5.1）第一次集成测试记录
a）时间，参于人员
b）测试内容
c）测试过程记录
d）测试结果
e）评价
5.2）同5.1
6．测试中的例外
6.1）无法达到的极限
6.2）不确定的元素
6.3）测试无法涵盖部分
7．其它
十一、用户手册
1引言
1.1编写目的
提示：
说明编写这份用户手册的目的，指出预期的读者
1.2背景
该软件系统的名称
该软件项目的任务提出者：
该软件项目的开发者：
该软件系统的用户（或首批用户）：
安装此软件的计算中心：
1.3定义
提示：
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料
提示：
列出用的着的参考资料，如
a.本项目的经核准的计划任务书或合同，上级机关的批文。
b.属于本项目的其他已发表的文件
c.本文件中各处引用的文件、资料、包括所需用到的软件开发标准。
2用途
2.1功能
提示：
结合本软件的开发目的逐项地说明本软件所具有各项功能经及它们的极限范围。
2.2性能
2.2.1精度
提示：
逐项说明对各项输入数据的精度要求和本软件输出数据达到的精度，包括传输中的精度要求。
2.2.2时间特性
提示：
定量地说明本软件的时间特性，如响应时间，更新处理时间，数据传输、转换时间，计算时间等。
2.2.3灵活性
提示：
说明本软件所具的的灵活性，即当用户需求（如对操作方式、运行环境、结果精度、时间特性等的需求）有某些变化时，本软件的适应能力。
2.3安全保密
提示：
说明本软件在安全、保密方面的设计考虑和实际达到的能力。
3运行环境
3.1硬设备
提示：
列出为运行本软件所要求的硬设备的最小配置，如：
a.处理机的型号、内存容量；
b.所要求的外存储器、媒体、记录格式、设备的型号和台数、联机/脱机；
c.I/O设备（联机/脱机？
）；
d.数据传输设备和转换设备的型号、台数。
3.2支持软件
提示：
说明为运行本软件所需要的支持软件，如：
a.操作系统的名称、版本号；
b.程序语言的编译、汇编系统的名称和版本号；
c.数据库管理系统的名称和版本号；
d.其他支持软件。
3.3数据结构
提示：
列出为支持本软件的运行所需要的数据库或数据文卷。
4使用过程
提示：
在本章，首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。
4.1安装与初始化
提示：
一步一步地说明为使用本软件而需进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复、表征安装工作完成的测试实例等。
如虹有的话，还应说明安装过程中所需用到的专用软件。
4.2输入
提示：
规定输入数据和参量的准备要求。
4.2.1输入数据的现实背景
提示：
说明输入数据的现实背景，主要是：
a.情况——例如人员变动、库存缺货；
b.情况出现的频度——例如是周期性的、随机的、一项操作状态的函数；
c.情况来源——例如人事部门、仓库管理部门；
d.输入媒体——例如键盘、穿孔卡片、磁带；
e.限制——出于安全、保密考虑而对访问这些输入数据所加的限制；
f.质量管理——例如对输入数据合理性的检验以及当输入数据有错误时应采取的措施，如建立出错情况的记录等；
g.支配——例如如何确定输入数据是保留还是废弃，是否要分配给其他的接受者等。
4.2.2输入格式
提示：
说明对初始输入数据和参量的格式要求，包括语法规则和有关约定，如：
a.长度——例如字符数/行，字符数/项；
b.格式基准——例如以左面的边沿为基准；
c.标号——例如标记或标识符；
d.顺序——例如各个数据项的次序及位置；
e.标点——例如用来表示行、数据组等的开始或结束语而使用的空格、斜线、星号、字符组等；
f.词汇表——给出允许使用的字符组合的列表，禁止使用的字符组合的列表等；
g.省略和重复——给出用来表示输入元素可省略或重复的表示方式；
h.控制——给出用来表示输入开始或结束的控制信息。
4.2.3输入举例
提示：
为每个完整的输入形式提供样本，包括：
a.控制或首部——例如用来表示输入的种类和类型的信息，标识符输入日期，正文起点和对所用编码的规定；
b.主体——输入数据的主体，包括数据文卷的输入表述部分；
c.尾部——用来表示输入结束的控制信息，累计字符总数等；
d.省略——指出哪些输入数据是可省略的；
e.重复——指出哪些输入数据是重复的。
4.3输出
提示：
对每项给出作出说明。
4.3.1输出数据的现实背景
提示：
说明输出数据的现实背景，主要是：
a.使用——这些输出数据是给谁的，用来干什么；
b.使用频度——例如每周的、定期的或备查阅的；
c.媒体——打印、CRI显示、磁带、卡片、磁盘；
d.质量管理——例如关于合理性检验、出错纠正的规定；
e.支配——例如如何确定输出数据是保留还是废弃，是否要分配给其他接受者等。
4.3.2输出格式
提示：
给出对每一类输出信息的解释，主要是：
a.首部——如输出数据的标识符，输出日期和输出编号；
b.主体——输出信息的主体，包括分栏标题；
c.尾部——包括累计总数，结束标记。
4.3.3输出举例
提示：
为每种输出类型提供例子。
对例子中的每一项，说明：
a.定义——每项输出信息的意义和用途；
b.来源——是从特定的输入中抽出、从数据库文卷中取出、或从软件的计算过程中得到；
c.特性——输出的值域、计量单位、在什么情况下可缺省等。
4.4文卷查询
提示：
这一条的编写针对具有查询能力的软件，内容包括：
同数据库查询有关的初始化、准备、及处理所需要的详细规定，说明查询的能力、方式，所使用的命令和所要求的控制规定。
4.5出错处理和恢复
提示：
列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。
指出为了确保再启动和恢复的能力，用户必须遵循的处理过程。
4.6终端操作
提示：
当软件是在多终端系统上工作时，应编写本条，以说明终端的配置安排、连接步骤、数据和参数输入步骤以及控制规定，说明通过终端操作进行查询、检索、修改数据文卷的能力、语言、过程以及辅助性程序等。
十二、项目总结报告
1引言
1.1编写目的
提示：
说明编写这份项目开发总结报告的目的，指出预期的阅读范围。
1.2背景
本项目的名称:
开发出来的软件系统的名称：
此软件和任务提出者：
此软件的开发者：
此软件的用户：
安装此软件的计算中心：
1.3定义
提示：
列出本文件中用到的专门术语的定义和外文首字母词的原词组。
1.4参考资料
提示：
列出参考资料文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2实际开发结果
2.1产品
提示：
说明最终制成的产品，包括：
a.程序系统中各个程序的名字：
模块名、程序库名及大小
b.程序系统共有哪几个版本，各自的版本号及它们之间的区别
c.每个文档的名称
d.所建立的每个数据库。
（如果开发中制订过配置管理计划，要同这个计划相比较）。
2.2主要功能和性能
提示：
逐项列出本软件产品所实际具有的主要功能和性能，对照可行性研究报告、项目开发计划、功能需求说明书的有关内容，说明原定的开发目标是达到了、未完全达到、或超过了。
2.3基本流程
提示：
用流程图画出本程序系统的实际的基本的处理流程。
2.4进度
提示：
列出原定计划进度与实际进度的对比，明确说明，实际进度是提前了、还是延迟了，分析主要原因。
2.5费用
提示：
列出原定计划费用与实际支出费用的对比，包括：
a.提示：
工时，以人月为单位，并按不同级别统计；
b.提示：
计算机的使用时间，区别CPU时间及其他设备时间；
c.提示：
物料消耗、出差费等其他支出。
明确说明经费是超出了、还是节余了，分析原因。
3开发工作评价
3.1对项目完成情况的评价
提示：
对程序编制、调试、通过测试的完成情况进行评价，对相应文档编写情况进行评价，指明是提前、按期或超期完成，并分析原因。
3.2对产品质量的评价
提示：
说明在测试中检查出来的错误发生率，即每10K字节中的错误数。
如果开发中制订过质量保证计划或配置管理计划，要同这些计划相比较。
3.3对技术方法的评价
提示：
给出对在开发中所使用的技术、方法、工具、手段的评价。
3.4出错原因的分析
提示：
给出对于开发中出现的错误的原因分析。
4经验与教训
提示：
列出从这项开发工作中所得到的最主要的经验与教训及对今后的项目开发工作的建议。
升级会员 