软件工程实验指导书_文档模板与案例

《软件工程》实验指导书软件工程平台课项目组北京联合大学信息学院2012年4月实验指导书北京联合大学I目录第二部分软件开发文档模板.........................................................................................................1（一）需求规格说明书模板...................................................................................................1（二）总体设计说明书模板...................................................................................................3（三）软件测试计划模板.......................................................................................................5（四）软件测试用例设计书模板...........................................................................................6第四部分主要文档实例.................................................................................................................7（一）图书管理系统需求规格说明书...................................................................................7（三）大学图书馆管理系统设计说明书.............................................................................23（四）大学图书馆管理系统测试用例设计书.....................................................................46软件工程实验指导书北京联合大学1第二部分软件开发文档模板（一）需求规格说明书模板1.引言1.1编写目的概述开发本系统的意图，编写本文档的用途和主要作用。1.2背景概要描述项目开发的背景。1.3定义将用户需求报告中的术语、缩写进行定义,包括用户应用领域和计算机领域的术语与缩写等。1.4参考资料2．任务概述2.1目标项目的目标是将目的细化后的具体描述。项目目标应是明确的、可度量的、可以达到的,项目的范围应能确保项目的目标可以达到。对于项目的目标可以逐步细化，以便与系统的需求建立对应关系，检查系统的功能是否覆盖了系统目标。2.2用户特点本系统所涉及的用户的描述。2.3假定与约束3.需求分析建模3.1功能需求对具体功能需求进行细化分析，并用图形工具进行描述。3.1.1系统需求描述说明：用语言描述系统的总体需求。3.1.2总体功能分析标识该软件必须满足的各个功能需求。说明：分析出系统的总体功能模型（如用数据流图来描述）例如：（1）系统的输入输出（2）系统主要功能3.1.2功能模块分析软件工程实验指导书北京联合大学2用名称和项目唯一标识号标识该软件的各个功能，并陈述各功能的宗旨，用能度量的术语描述它的性质。标识和陈述与各功能有关的每个输入输出。说明：详细描述每个功能的流程、数据流等。3.2性能需求3.2.1精度对各项需求中相关数据的精度要求等。3.2.2时间特性要求如：（1）响应时间，如查询的最长等待时间。（2）更新处理时间，如记账的最长时间。（3）数据的转换和传送时间，如远程数据传输的时间要求。（4）解题时间。„„3.3数据需求3.3.1输入\输出数据要求对输入和输出数据格式的特殊要求等。3.3.2数据分析模型(E-R图)3.4故障处理要求3.5其他专门要求如：（1）进度需求：系统的阶段进度要求。（2）运行环境需求：平台、体系结构、设备要求。（3）培训需求：用户对培训的需求，是否提供多媒体教学光盘。（4）推广需求：如在上百个远程部门推广该系统，是否要有推广的支持软件。4.运行环境规定4.1设备4.2支持软件4.3接口4.4控制软件工程实验指导书北京联合大学3（二）总体设计说明书模板1引言1.1编写目的1.2背景a.待开发的软件系统的名称b.本项目的任务提出者c.本项目的任务开发者d.本项目的任务用户1.3术语术语定义或解释，一般用表格形式给出，如表2-1所示。表2-1术语定义或解释表序号术语名称术语定义121.4参考资料2系统总体设计2.1体系结构设计如采用结构化方法进行设计，则画出模块图上层框架；如采用面向对象方法进行设计，则采用包图画出系统的体系结构模型。2.2子系统描述子系统清单，如表2-2所示。表2-2子系统清单子系统编号子系统英文名子系统功能简述子系统之间的关系122.3功能模块描述模块（类）清单，如表2-3所示。表2-3模块清单模块编号模块英文名模块功能简述模块的接口简述M1-1M1-2M2-1M2-22.4模块设计采用结构化方法：细化每个功能，并用IPO图对模块进行设计说明采用面向对象技术：用类图说明各个类属性和方法以及类之间的关系，对软件工程实验指导书北京联合大学4于复杂类要画出状态图和顺序图（时序图）。设计出功能界面。3．数据结构设计3.1数据库表名清单数据库表名清单，如表2-4所示。表2-4数据库表名清单序号中文表名英文表名表功能说明1233.2数据库表之间关系说明可以用E-R图表示，也可以用文字说明。3.3数据库表的详细清单每个表的详细清单内容包括：表名、字段中文名、字段英文名、字段的类型、宽度、精度、主键/外键、空否、取值约束（默认值、最大值、最小值）、索引否。同时要指出该表的索引：索引文件名、索引字段名、索引特性（主键索引、惟一索引unique、聚集索引clustered）。详细清单可以用列表给出，如2-5所示。表2-5表名序号字段中文名字段英文名类型、宽度、精度取值约束空否默认值主键/外键索引否123.4视图设计视图设计中要给出视图的中文名、英文名，视图中的中文列名、英文列名、类型、宽度、精度，每一列的具体算法，对应的基本表名。3.5其他数据结构设计此小节描述系统的其他数据结构设计内容。4．接口设计（InterfaceDesign）对应每一个接口，都要详细列出下列内容，包括：（1）接口名称（2）接口内容（3）接口设施（4）接口的数据结构（5）接口的传输速率（Mbps）和带宽（6）接口协议5系统的安全可靠处理软件工程实验指导书北京联合大学5（三）软件测试计划模板1．引言1.1目的1.2名词解释1.3参考资料1.4时间进度2．项目背景2.1项目来源与目标2.2测试范围2.3项目人员列出项目参与人员的职务、姓名、E-mail和电话。2.4测试文档测试过程中可能用到的参考文档、相关的设计文档以及保存位置，测试完成后应产生的文档。2.4.1测试参考文档2.4.2测试提交文档3．质量目标3.1产品质量目标3.2测试质量目标描述本阶段测试目标和要求。质量目标应该包括产品的质量目标和测试小组的质量目标。4．资源需求4.1测试环境4.1.1硬件测试环境描述建立测试环境所需要的设备、用途及软件部署计划。4.1.2软件测试环境4.2测试工具将列出测试使用的工具以及用途。5．测试策略5.1测试类型5.2测试内容软件工程实验指导书北京联合大学65.3测试技术(1)功能测试(2)性能测试(3)易用性测试(4)内容测试(5)安全性测试(6)接口测试6测试进度计划对项目各阶段的测试工作制订时间进度计划。（四）软件测试用例设计书模板1、编写目的2、内容本文档包括对系统功能测试、性能测试、安全性测试的测试用例设计。3、测试用例3.1.功能测试3.2性能测试3.3安全性测试软件工程实验指导书北京联合大学7第四部分主要文档实例（一）图书管理系统需求规格说明书1.引言1.1编写目的需求的编写是为了确认图书管理系统软件的功能、性能和数据等方面的需求。同时它也是进行项目策划、概要设计和详细设计的基础，是维护人员进行内部维护，信息更新，验收和测试的依据。本需求的预期读者是与图书管理系统软件开发有联系的决策人，开发组成人员，扶助开发者，支持本项目的领导和公司人员，软件验证者。1.2背景人工管理图书的手续繁索、效率低下给具有强烈时间观念的管理人员带来了诸多不便，学校图书馆缺少一套完善的图书管理软件，为了对图书的管理方便，因此必须开发图书管理系统。随着计算机技术的不断应用和提高，计算机已经深入到社会生活的各个角落。而采用手工管理图书的方法，不仅效率低、易出错、手续繁琐，而且耗费大量的人力。为了满足图书馆管理人员对图书馆书籍，读者资料，借还书等进行高效的管理，在工作人员具备一定的计算机操作能力的前提下，特编此图书管理系统软件以提高图书馆的管理效率。1.3定义无1.4参考资料[1]钱乐秋等，《软件工程》，清华大学出版社；[2]张海藩，《软件工程导论》（第五版），清华大学出版社；[3]王珊等，《数据库原理及设计》，清华大学出版社；[4]赵池龙等，《软件工程实践教程》，电子工业出版社。[5]谈书次号的标准化--《四川图书馆学报》2003年05期[6]专业图书馆网——图书馆自动化管理系统-系统简介2．任务概述2.1目标本系统通过强大的计算机技术给图书管理人员和读者借、还书带来便利。本系统除了图书馆内管理的一般功能还外，还包括网上在线查询图书信息、查询本软件工程实验指导书北京联合大学8人的借阅情况和续借等功能。目标还包括：1）减少人力与管理费用；2）提高信息准确度；3）改进管理和服务；4）建立高效的信息传输和服务平台，提高信息处理速度和利用率；5）系统设计优良，界面设计精美、友好、快捷，人性化设计，后台管理功能强大、效率高；更简便、信息化程度更高的图书管理流程；2.2用户特点本软件的最终用户是面向管理员（图书管理员和其它管理人员）、读者（老师和同学等），他们都具有一定的计算机应用基础，可以比较熟练操作计算机。管理员和读者都是经常性用户。系统维护人员为计算机专业人员，熟悉数据库、操作系统、网络维护工作。维护人员为间隔性用户。2.3假定与约束无3.需求分析及建模3.1系统内部人员结构、组织及用户情况分析为了对系统有一个全貌性的了解，首先要对系统内部人员结构、组织及用户情况有所了解。图书馆系统的组织结构如图1所示。图1图书馆管理信息系统的组织结构图书馆由馆长负责全面工作，下设办公室、财务室、采编室、学术论文室、图书借阅室、电子阅览室、期刊阅览室和技术支持室。各部门的业务职责如下。办公室：办公室协助馆长负责日常工作，了解客户需求，制定采购计划。财务室：财务室负责财务方面的工作。采编室：采编室负责图书的采购，入库和图书编目，编目后的图书粘贴标签，并送图书借阅室上架。学术论文室：负责学术论文的收集整理。图书借阅室：提供对读者的书目查询服务和图书借阅服务。电子阅览室：收集整理电子读物，准备提供电子读物的借阅服务，目前可以提供目录查询和借阅。软件工程实验指导书北京联合大学9期刊阅览室：负责情况的收集整理和借阅。技术支持室：负责对图书馆的网络和计算机系统提供技术支持。3.2功能需求3.2.1系统需求描述通过业务调查，图书管理系统的主要业务和业务的流程描述如下：读者来图书馆借书，可能先查询馆中的图书信息。查询可以按书名、作者、图书编号、关键字查询。如果查到则记下书号，交给流通组工作人员，等待办理借书手续。如果该书已经被全部借出，可做预定登记，等待有书时被通知。如果图书馆没有该书的记录，可进行缺书登记。办理借书手续时先要出示借阅证，没有图书证则去图书馆办公室申办图书证