版软件工程实验指导书1.docx
《版软件工程实验指导书1.docx》由会员分享，可在线阅读，更多相关《版软件工程实验指导书1.docx（17页珍藏版）》请在冰豆网上搜索。
版软件工程实验指导书1
一、项目开发计划书
完成人：
1．引言（Introduction）
1.1项目概述（ProjectSummary）
给出项目的初始描述。
1.2术语定义（TermsGlossary）
将该软件开发计划中的术语、缩写词进行定义。
1.3相关文档（RelatedDocuments）
当该文档变更时，可能对其他文档产生影响，受影响的文档叫相关文档，需将它们列出。
[1]……
[2]……
2．软件生存周期（SoftwareLifeCycle）
本节记录项目策划生存期定义的工作结果，需要描述的主要内容：
（1）项目生存期框图
（2）项目生存期说明
3．任务与工作产品（TaskandWorkProducts）
项目任务和工作产品，是指根据项目生存期阶段划分的任务，和相应阶段的工作产品。
记录项目生存期各阶段确定的需重点控制的阶段任务和工作产品。
建议以表格的形式，列出生存期各阶段的任务和工作产品。
项目包含的任务，如：
（1）需求分析
（2）系统设计
（3）系统实现
（4）测试
（5）产品交付
项目可能包含的产品，如：
（1）需求规格说明书
（3）系统设计说明书
（4）源程序
（5）测试报告
（6）用户手册
4．工作产品、任务规模、工作量估计（EstimatesofWorkProduct，TaskSizeandWorkload）
项目规模估算是为了确定项目所需的人工。
需要描述的主要内容有：
（1）对软件工作产品规模估计依据的简要描述。
（2）每种任务和工作产品规模估计的结果。
（3）规模估算的结果，建议用表格的形式列出。
5．资源需求计划（ResourceRequirementPlan）
指系统在开发环境、测试环境、及用户目标环境中，对计算机软、硬件资源的要求，如计算机存储能力、计算机处理器速度、通信通道容量、服务器处理能力等的估计。
6．软件项目进度计划（SoftwareProjectSchedule）
软件项目进度计划，是对项目的进度、人员工作分工所做的计划，此计划依据上述的估算和分析结果，计划方式建议采用表格的形式。
若采用工具制定项目计划，应将工具生成的图表作为项目计划的附件。
本节中需要描述的主要内容有：
（1）软件项目任务分解
（2）设定的里程碑
（3）开始和结束时间
（4）缓冲时间
（5）人员分配
二、需求规格说明书
完成人：
1．概述（Summary）
1.1项目的目的与目标（PurposeandAimofProject）
项目的目的是对开发本系统意图的总概括。
项目的目标是将目的细化后的具体描述。
项目目标应是明确的、可度量的、可以达到的,项目的范围应能确保项目的目标可以达到。
对于项目的目标可以逐步细化，以便与系统的需求建立对应关系，检查系统的功能是否覆盖了系统目标。
1.2术语定义（TermsGlossary）
将该用户需求报告中的术语、缩写进行定义,包括用户应用领域与计算机领域的术语与缩写等。
1.3相关文档（RelatedDocuments）
说明用户需求报告的变更，以及可能受变更影响的其他相关文档，如：
项目开发计划和设计说明书。
2．问题初始分析（EarlyAnalysis）
2.1场景描述（SceneDescription）
自然语言描述
2.2初始功能提取（EarlyFunctionDistill）
自然语言描述
3．目标系统功能需求（FunctionofTargetSystem）
3.1功能需求分析（FunctionAnalysis）
对具体功能需求进行细化分析，并用图形工具进行描述。
对于采用结构化分析方法的同学要求采用E-R图、数据流图和数据词典；
对于采用面向对象分析方法的同学要求采用业务类模型和用例图（必要时配合活动图和序列图）。
3.2功能需求点列表（FunctionList）
在功能需求分析完成后，要详细列出用户需求功能点列表，提供给后续设计、编程、测试中使用，更是为了用户测试验收中使用。
功能需求点列表的格式，如表2-1所示。
表2-1功能需求点列表
编号
功能名称
使用人
功能描述
输入内容
输出内容
1
2
3
4．目标系统性能需求（PerformanceofTargetSystem）
4.1时间要求（TimeRequest）
如：
（1）响应时间，如查询的最长等待时间。
（2）更新处理时间，如记账的最长时间。
（3）数据的转换和传送时间，如远程数据传输的时间要求。
（4）解题时间。
4.2空间要求（SpaceRequest）
如：
（1）支持的终端数。
（2）支持的并行操作的使用者数。
（3）处理的文件和记录数。
（4）处理任务的数量。
（5）对输入和输出数据的精度要求。
（6）对处理和传输过程中的精度要求。
4.3性能需求点列表（PerformanceList）
详细列出用户性能点列表，提供给后续分析、设计、编程、测试中使用，更是为了用户测试验收中使用。
需求性能点列表的格式，如表2-2所示。
表2-2性能需求点列表
编号
性能名称
使用部门
使用岗位
性能描述
输入内容
输出内容
1
2
3
5．目标系统界面与接口需求（InterfaceofTargetSystem）
5.1界面需求（InterphaseRequirement）
界面的原则要求，如方便、简洁、美观、一致等。
整个系统的界面风格定义，某些功能模块的特殊的界面要求。
（1）输入设备：
键盘、鼠标、条码扫描器、扫描仪等；
（2）输出设备：
显示器、打印机、光盘刻录机、磁带机、音箱等；
（3）显示风格：
图形界面、字符界面、IE界面等；
（4）显示方式：
1024*768、640*480等；
（5）输出格式：
显示布局、打印格式等。
5.2接口需求（InterfaceRequirement）
与其他系统的接口，如监控系统、控制系统、银行结算系统、税控系统、财务系统、政府网络系统及其他系统等。
（1）与系统特殊外设的接口，如CT机、磁共振、柜员机（ATM）、IC卡、盘点机等。
（2）与中间件的接口，要列出接口规范、入口参数、出口参数、传输频率等。
应在此列举出所有的外部接口名称、接口标准、规范。
外部接口列表，如表2-3所示。
表2-3外部接口需求点列表
编号
接口名称
接口规范
接口标准
入口参数
出口参数
传输频率
1
2
3
6．目标系统其他需求（OtherRequirementsofTargetSystem）
6.1安全性（Security）
6.2可靠性（Dependability）
6.3灵活性（Agility）
6.4特殊需求（SpecialRequirements）
如：
（1）进度需求：
系统的阶段进度要求。
（2）运行环境需求：
平台、体系结构、设备要求。
（3）培训需求：
用户对培训的需求，是否提供多媒体教学光盘。
（4）推广需求：
推广的要求，如在上百个远程部门推广该系统，是否要有推广的支持软件。
7．目标系统假设与约束条件（SupposeandRestrictionofTargetSystem）
假设与约定条件是对预计的系统风险的描述,如：
（1）法律、法规和政策方面的限制。
（2）硬件、软件、运行环境和开发环境方面的条件和限制。
（3）可利用的信息和资源。
（4）系统投入使用的最晚日期。
三、设计规格说明书
完成人：
1．引言（Introduction）
本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。
1.1目的（Purpose）
本文档的目旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。
1.2命名规则（NamingRule）
变量对象命名规则：
申明全局变量、局部变量对象的命名规则。
数据库对象命名规则：
申明数据库表名、字段名、索引名、视图名等对象的命名规则。
1.3术语定义（TermsGlossary）
术语定义或解释一般用表格形式给出，如表3-1所示。
表3-1术语定义或解释表
序号
术语名称
术语定义
1
总体结构
软件系统的总体逻辑结构。
按照不同的设计方法，有不同的总体逻辑结构。
若采用面向功能或面向数据的设计方法，则总体逻辑结构为一树形的功能模块结构图。
若采用面向对象或面向部件（构件）的设计方法，则总体逻辑结构为部件（构件）的组装图
2
外部接口
本软件系统与其他软件系统之间的接口，接口设施可以是中间件。
接口描述包括：
传输方式、带宽、数据结构、传输频率、传输量、传输协议
3
数据结构
数据结构包括：
数据库表的结构、其他数据结构等
4
概念数据
模型CDM
关系数据库的逻辑设计模型，叫做概念数据模型。
主要内容包括一张逻辑E-R图及其相应的数据字典
5
物理数据
模型PDM
关系数据库的物理设计模型，叫做物理数据模型。
主要内容包括一张物理表关系图及其相应的数据字典
6
视图
在基表或其他视图之上建立的一张虚表，叫做视图，它具有物理表的许多性质，在数据处理和授权上很有用
7
角色
数据库中享有某些特权操作的用户，叫做角色。
角色的权利通过授权来实现
8
子系统
具有相对独立功能的小系统叫做子系统。
一个大的软件系统可以划分为多个子系统，每个子系统可由多个模块或多个部件组成
9
模块
具有功能独立、能被调用的信息单元叫做模块。
模块是结构化设计中的概念
10
内部接口
软件系统内部各子系统之间、各部件之间、各模板之间的接口，叫做内部接口。
接口描述包括：
调用方式、入口信息、出口信息等
11
相关文件
相关文件是指当本文件内容变更后，可能引起变更的其他文件。
如需求分析报告、详细设计说明书、测试计划、用户手册
12
参考资料
参考资料是指本文件书写时用到的其他资料。
如各种有关规范、模板、标准、准则
1.4参考资料（References）
[1]用户需求报告
[2]数据库设计规范
[3]命名规范
1.5相关文档（RelatedDocuments）
[1]源程序清单
[2]测试计划及报告
[3]《用户使用手册》
2．总体设计（DesignofCollective）
2.1体系结构设计（DesignofArchitecture）
软件系统的结构，按照不同的设计方法，有不同的总体逻辑结构。
若采用结构化设计方法，可采用分层框图画出系统总体结构图，列出系统的功能模块清单编号、名称、功能，并尽可能描绘出功能模块之间的关系。
若用面向对象的方法设计，则采用包图画出体统的体系结构模型，然后进行扩展，画出个子系统内构成及模块之间的关系。
2.2子系统清单（SubsystemList）
子系统清单，如表3-2所示。
表3-2子系统清单
子系统编号
子系统英文名
子系统功能简述
子系统之间的关系
SS1
SS2
SS3
2.3模块设计（ModuleDesign）
对模块实现细节进行设计，功能函数要求画出流程图；
对象类用类图说明各种属性和方法，对于复杂对象要画出状态图。
2.4功能模块清单（ModuleList）
模块（功能函数或类）清单，如表3-3所示。
表3-3模块清单
模块编号
模块英文名
模块功能简述
模块的接口简述
M1-1
M1-2
M2-1
M2-2
3．数据结构设计（DesignofDataStructure）
3.1数据库表名清单（DBTableList）
数据库表名清单，如表3-4所示。
表3-4数据库表名清单
序号
中文表名
英文表名
表功能说明
1
2
3
3.2数据库表之间关系说明（RelationofDBTable）
可以用E-R图表示，也可以用文字说明。
3.3数据库表的详细清单（ParticularListofDBTable）
每个表的详细清单内容包括：
表名、字段中文名、字段英文名、字段的类型、宽度、精度、主键/外键、空否、取值约束（默认值、最大值、最小值）、索引否。
同时要指出该表的索引：
索引文件名、索引字段名、索引特性（主键索引、惟一索引unique、聚集索引clustered）。
详细清单可以用列表给出，如表3-5所示。
表3-5表名：
XXXX
序号
字段中文名
字段英文名
类型、宽度、精度
取值约束
空否
默认值
主键/外键
索引否
1
2
3
3.4视图设计（ViewDesign）
视图设计与授权有关，设计时参照需求文档的用户授权范围。
视图设计中要给出视图的中文名、英文名，视图中的中文列名、英文列名、类型、宽度、精度，每一列的具体算法，对应的基本表名。
3.5其他数据结构设计（DesignofOtherDataStructure）
此小节描述系统的其他数据结构设计内容。
4．接口设计（InterfaceDesign）
对应每一个接口，都要详细列出下列内容。
（1）接口名称
（2）接口内容
（3）接口设施
（4）接口的数据结构
（5）接口的传输速率（Mbps）
（6）接口带宽
（7）接口协议
四、测试报告
完成人：
1.概述（Summary）
1.1项目简介（ProjectSynopsis）
在本章节中简介项目的基本情况。
1.2术语定义（TermsGlossary）
将该测试报告中的术语、缩写进行定义,包括用户应用领域与计算机领域的术语与缩写等。
1.3参考资料（References）
说明该测试报告使用的参考资料，如：
[1]《需求规格说明书》
[2]《设计规格说明书》
2.组件测试（ModuleTest）
2.1功能模块清单
由《设计规格说明书》拷贝到的模块清单，如表4-1所示。
表4-1模块清单
模块编号
模块英文名
模块功能简述
模块的接口简述
M1-1
M1-2
M2-1
M2-2
2.2组件测试报告（ReportforModuleTest）
选择一个模块，应用基本路径法设计测试用例，进行现场测试。
要求画出程序流程图，表示每条基本路径，记录测试数据，评定测试结果。
测试活动的记录格式，如表4-2所示。
表4-2模块测试记录
编号
路径标识
输入
期望输出
输出内容
发现问题
测试结果
测试时间
测试人
1
√
2
√
3
√
4
×
3．功能测试（FunctionTest）
3.1系统功能需求（FunctionRequestofTargetSystem）
由《需求规格说明书》拷贝到的功能需求点列表，如表4-3所示。
表4-3功能需求点列表
编号
功能名称
使用人
功能描述
输入内容
输出内容
1
2
3
3.2.功能测试报告（ReportforFunctionTest）
按照功能点列表内容，结合等价类划分法设计测试用例（输入/输出内容），进行现场测试，记录测试数据，评定测试结果。
测试活动的记录格式，如表4-4所示。
表4-4功能测试记录
编号
功能名称
输入内容
期望输出
输出内容
发现问题
测试结果
测试时间
测试人
1
√
2
√
3
√
4
×
4.测试结论（TestVerdict）
当测试完成之后，测试人员应对本次测试做出结论。
格式如下：
测试日期：
测试地点：
测试环境：
列出系统的强项：
列出系统的弱项：
列出不符合项的统计结果：
测试人员签字：
五、用户手册
完成人：
1．前言（Preface）
提供手册的概述，在此可以说明编写这份手册的目的、指明本手册的读者。
1.1内容简介（Introduction）
简单地介绍编写背景，系统适用的用户。
1.2基本概念（BasicConcept）
说明定义的术语在本手册中的含义。
1.3主要功能（MostlyFunction）
对系统进行简单讲解和功能介绍。
1.4操作流程（OperateFlow）
操作流程说明。
全面模拟用户操作，从安装、进入、初始化、到用户具体操作，对整个流程进行描述。
1.5步骤说明（StepShow）
针对操作流程的每一步进行说明。
如果在使用说明中有相应的解释，应指明用户查找的位置。
2．功能（Function）
这部分包括用户使用的所有功能，是用户使用手册的最重要的部分，要详细描述。
2.1使用流程（UseFlow）
描述具体功能的使用顺序。
如果功能之中有分类，比如，有些功能用户用不到，有些用得到，就要分开写流程。
2.2具体描述（Description）
描述顺序是按照使用流程的每一步进行的。
2.3进行此功能的业务介绍（OperationIntroduce）
对此功能进行简单介绍，说明所能完成的功能。
2.4操作步骤（HandleStep）
用鼠标选择相应的功能，进入相应的界面，进行功能键以及栏目的介绍。
2.5举例（Example）
针对某一功能，对于一些比较难的问题，应该进行举例说明。
2.6特殊提示及注意事项（PromptandNotice）
在使用说明中，每一部分都会归纳一些问题，需要提示用户或者让用户注意，应按照以下规定的格式进行编写：
字体采用仿宋字，字号采用小五号字。
3．附录（Appendix）
对一些在正文中描述不够详尽的地方，可在附录中进行补充；用户经常遇到的问题及问题解答也可放在附录中。
升级会员 