概要设计说明书.doc

概要设计说明书编写规范案卷号日期XX集团网络化运营系统 概要设计说明书作者：王立峰完成日期： 2000/11/3签收人：签收日期：修改情况记录：版本号 修改批准人 修改人 安装日期 签收人概要设计说明书编写规范目录1 引言 . 11.1 编写目的 .11.2 范围 .11.3 定义 .11.4 参考资料 .42 总体设计 . 62.1 需求规定 .62.2 运行环境 .142.3 基本设计概念和处理流程 .172.4 结构 .错.误.！. 未定义书签。2.5 功能需求与程序的关系 .192.6 人工处理过程 .362.7 尚未解决的问题 .363 接口设计 . 63.1 用户接口 .363.2 外部接口 .373.3 内部接口 .394 运行设计 . 454.1 运行模块组合 .454.2 运行控制 .484.3 运行时间 .635 系统数据结构设计 . 455.1 逻辑结构设计要点 .645.2 物理结构设计要点 .645.3 数据结构与程序的关系 .676 系统出错处理设计 . 686.1 出错信息 .686.2 补救措施 .696.3 系统维护设计 .69概要设计说明书编写规范1 引言1.5 编写目的本概要设计说明书根据教育培训系统需求规格说明书编写，描述了系统的概要设计，并为下一步的 “系统详细设计说明书” 的编写提供依据， 为系统测试人员提供测试依据。本文档的预期读者：项目经理、系统分析员、测试经理、项目组长、系统开发人员1.6 范围教育培训系统：本系统主要实现学员登录报名与录取管理， 学员和教师的管理， 课程的管理， 费用管理，其它功能暂时不会涉及。本系统为了开展上述工作而设计了组织机构的设置， 管理角色的设置， 会员的管理设置。本系统为了对成绩的管理而编制了各项的统计报表。本系统实现对学员信息，成绩，课程的管理，比如增加，删除，修改等功能本系统实现对教师信息，课程的管理，比如增加，删除，修改等功能本系统实现对管理员管理，管理员实现对学员信息，教师信息的后台管理项目提出者：吴光成老师项目开发者：朱磊、蒲勇、岳潇潇、童谣、马三茜项目用户单位： XXXX 培训机构1.7 定义HTTP ：HyperText Transfer Protocol, 超文本传送协议； 一种详细规定了浏览器和万维网服务器之间互相通信的规则，通过因特网传送万维网文档的数据传送协议。HTML ：超文本标记语言，即 HTML （Hypertext Markup Language），是用于描述网页文档的一种标记语言。第 1 页概要设计说明书编写规范TCP/IP ：Transmission Control Protocol/Internet Protocol 的简写，中译名为传输控制协议/因特网互联协议，又名网络通讯协议，是 Internet 最基本的协议、 Internet 国际互联网络的基础，由网络层的 IP 协议和传输层的 TCP 协议组成。 TCP/IP 定义了电子设备如何连入因特网，以及数据如何在它们之间传输的标准。需求：用户解决问题或达到上档所需的条件或功能；系统或系统部件要满足合同、标准，规范或其它正式规定文档所需具有的条件或权能。UML 用例图：用例图主要用来图示化系统的主事件流程， 它主要用来描述客户的需求，即用户希望系统具备的完成一定功能的动作， 通俗地理解用例就是软件的功能模块， 所以是设计系统分析阶段的起点， 设计人员根据客户的需求来创建和解释用例图， 用来描述软件应具备哪些功能模块以及这些模块之间的调用关系， 用例图包含了用例和参与者， 用例之间用关联来连接以求把系统的整个结构和功能反映给非技术人员（通常是软件的用户） ，对应的是软件的结构和功能分解。数据流图（ Data Flow Diagram ）：简称 DFD，它从数据传递和加工角度，以图形方式来表达系统的逻辑功能、 数据在系统内部的逻辑流向和逻辑变换过程， 是结构化系统分析方法的主要表达工具及用于表示软件模型的一种图示方法。数据字典：（data dictionary ）数据库中所有对象及其关系的信息集合，一种用户可以访问的记录数据库和应用程序源数据的目录。DBMS ：数据库管理系统 (database management system)是一种操纵和管理数据库的大型软件，用于建立、使用和维护数据库，简称 DBMS 。它对数据库进行统一的管理和控制，以保证数据库的安全性和完整性。用户通过 DBMS 访问数据库中的数据，数据库管理员也通过 DBMS 进行数据库的维护工作。它可使多个应用程序和用户用不同的方法在同时或不同时刻去建立，修改和询问数据库。AGP：AGP（Accelerated Graphics Port）是英特尔公司配合 PentiumII 处理器开发的总线标准，它是建立 PCI 总线基础上、专门针对 3D 图形处理而开发的高效能总线。 AGP第 2 页概要设计说明书编写规范的插槽与 PCI 不兼容， AGP 的显示卡不能插在 PCI 总线上（ AGP 插槽比 PCI 要短），AGP最大的改进是达到了 133MHz 以上的数据传输速率，数据吞吐速度可以达到 533MB 秒以上。由于达到了这么高的传输速率， 便可以将图形内存中的数据调入系统内存， 从而大大地减轻图形内存的压力。JavaScript：JavaScript 是一种新的描述语言，此种语言可以被嵌入 HTML 的文件之中。通过 JavaScript 可以做到处理访问者的需求事件（如：表单的输入） ，而不用向网络来回传资料。所以，当访问者输入信息时，信息不用经过传给服务器处理之后，再传回来的过程，而是直接可以被客户端 (client) 的应用程序处理LAN 局域网： 局域网是一种小型网 (3 至 50 个节点 )，通常布置在一个公司 (或组织 )的办公区域内。 确切地说， 局域网只是与广域网相对应的一个词， 并没有严格的定义， 凡是小范围内的有限个通信设备互联在一起的通信网都可以称为局域网。 这里的通信设备可以包括微型计算机、 终端、外部设备、 电话机、 传真机等。 按照这种说法， 专用小型交换机 PBX(PrivateBranch eXchange) 也是一种局域网。 而我们通常所说的都是计算机局部网络， 简称为局域网。防火墙： 防火墙是连接区域网路和互联网供应商路由器的 "桥梁"电脑。 这些硬件专门设计用来拦截并过滤信息，只让符合严格安全标准的信息通过。防火墙一般可以分为两大类：网络层级和应用程式层级。格式化 : 指对磁盘进行使用前的预处理以便存入数据。一般而言 ,新盘是必须格式化的，而使用过的旧盘也可以格式化 ,格式化后磁盘上全部数据将被删除。模块化 :按照功能将一个软件切分成许多部分单独开发 ,然后再组装起来 ,每一个部分即为模块。其优点是利于控制质量、利于多人合作、利于扩充功能等 ,是软件工程中一种重要的开发方法。分辨率（ Resolution）：影象清晰度或浓度的度量标准。举例来说，分辨率代表垂直及水平显示的每英寸点（ dpi）的数量。 BitWare 可以用普通或标准（ 100 乘 200 dpi）及精细分辨率（ 200 乘 200 dpi）发送及接收传真文档。第 3 页概要设计说明书编写规范数据字典（ Data dictionary ）：是一种用户可以访问的记录数据库和应用程序源数据的目录。主动数据字典是指在对数据库或应用程序结构进行修改时，其内容可以由 DBMS 自动更新的数据字典。被动数据字典是指修改时必须手工更新其内容的数据字典。MSDN ：全称是 Microsoft Developer Network 。这是微软公司面向软件开发者的一种信息服务。 MSDN 实际上是一个以 Visual Studio 和 Windows 平台为核心整合的开发虚拟社区，包括技术文档、 在线电子教程、 网络虚拟实验室、 微软产品下载 （几乎全部的操作系统、服务器程序、 应用程序和开发程序的正式版和测试版， 还包括各种驱动程序开发包和软件开发包）、Blog、BBS、MSDN WebCast 、与 CMP 合作的 MSDN 杂志等等一系列服务。约束：数据属性的特性，用于指明服务。如，写数值、读数值、取代等服务可应用该数据属性特性。报表：企业管理的基本措施和途径，是企业的基本业务要求，简单的说：报表就是用表格、图表等格式来动态显示数据。可以用公式表示为： “报表 = 多样的格式 + 动态的数据”。服务器：指一个管理资源并为用户提供服务的计算机软件，通常分为文件服务器、数据库服务器和应用程序服务器。运行以上软件的计算机或计算机系统也被称为服务器。类图：UML 时序图：1.8 参考资料列出要用到的参考资料，如：a 本项目的经核准的计划任务书或合同、上级机关的批文；b 属于本项目的其他已发表的文件；第 4 页概要设计说明书编写规范c 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、 文件编号、 发表日期和出版单位， 说明能够得到这些文件资料的来源。教育培训系统需求说明书概要设计说明书编写规范教育培训系统计划任务书教育培训系统合同教育培训系统机关批文系统分析与设计机械工业出版社出版 2010 年 4 月（美） Kenneth E.Kendall JulieE.Kendall 著施平安郝清赋译MSDN 文档教育研究方法导论 ，安徽教育出版社， 1999 年版， 2009 年印刷裴娣娜著教育学基础第二版，教育科学出版社，全国十二所重点师范大学联合编写；教育学人民教育出版社 , 1999 年第三版王道俊、王汉澜著教育学基础第二版，教育科学出版社，全国十二所重点师范大学联合编写第 5 页概要设计说明书编写规范2 总体设计1.9 需求规定说明对本系统的主要的输入输出项目、 处理的功能性能要求， 详细的说明可参见 需求分析说明书 。需求描述如下表：表 3.1 招生录取功能需求功能 招生录取描述 用户通过在线报名方式网上进行在线报名，填写报名信息，通过系统验收后，由招生管理工作人员进行报名信息的筛选并进行审核，审核通过后系统通知学员是否被录取，并发放录取公告。输入 登录 1、 用户 ID2、 密码3、 验证码（与图片显示的验证码一致）报名 1、 真实姓名（必填）2、 证件号（必填）3、 学历（必填）4、 电话（必填）5、 邮箱6、 报名方向（专业方向） （必填）第 6 页概要设计说明书编写规范7、 经历（学习或者工作）8、 同意合同协议（必须）录取 1、是否录取处理 登录： 1、输入用户 ID ，密码，验证码；先检验验证码是否合格，再检测数据库中的用户信息表，用户类型表、用户权限表，进行用户的登录与权限的判定。验证具体要求：1、用户 ID 只允许有数字、字母、下划线组成2、查找数据库中该用户 ID 所对应的密码是否与用户输入相同，并作出判断3、验证用户输入的验证与服务器中保存的验证码信息是否一致 （保存于 Session 中的信息）报名： 1、用户输入真实姓名，学历，电话，邮箱，经历，选择报名方向，同意合同协议，提交数据，先进行输入验证（填写是否符合要求，是否规范） ，验证全部通过后系统将提交的数据保存入数据库中。第 7 页概要设计说明书编写规范验证具体要求：1、姓名中不允许有特殊字符（例如“ * ”、“_”、“+”等）；2、电话号码只能为数字， 不允许出现字母与汉字。3、邮箱必须为合法的邮箱格式。4、必须选择你想学习的专业方向5、只有同意协议后才能报名录取：1、招生管理人员查看学员的报名信息（取出数据库中的数据） ，经过审核后，确认是否录取。2、录取后将录取学员的信息保存进数据库中。输出 登录： 1、登录验证失败弹出警告框提示2、登录成功后进入相应的权限页面报名：1、报名信息验证不正确时，进行相提示输入不正确，并将焦点显示在出错的位置上。2、确认同意协议后，系统弹出提示框请求用户再次确认。3、在报名时学员查看的协议（见附录一）录取： 1、显示录取的名单。从数据库取出录取学员的信息并显示。第 8 页概要设计说明书编写规范招生录取数据流图：报名信息1.10填写报名信息报名信息 1.2信息审核 审核通过信息 D1 报名信息报名信息2.8报名信息统计查询统计信息报名信息3.4发放通知录取信息4.4录取合格者筛选后的信息5.4筛选信息筛选条件通知图 3.4 招生录取数据流图课程管理用例图：课程管理- 端25* - 端26学员课程安排 - 端20* - 端21*学员 *- 端22 - 端19*课程安排*培训管理人员- 端24*- 端27 -端23 - 端28*教师授课安排*教师第 9 页概要设计说明书编写规范图 3.5 课程管理用例图课程管理需求描述：表 3.2 学员课程安排功能需求描述功能 学员课程安排描述 学员可以通过登录该网站在网上进行查询自己的个人课表，每个人根据自己所报的专业不一样课程也即不一样，授课教师也不一样，学员上课的课表由课程管理人员经过查看学员专业的方向和教师的信息后安排学员课程。输入 登录： 1、用户 ID2、密码3、验证码（与图片显示的验证码一致）课程安排：1、选择查询某个时间段的课程安排2、学员的专业方向3、教师的属于什么专业处理 登录：1、输入用户 ID ，密码，验证码；先检验验证码是否合格，再检测数据库中的用户信息表， 用户类型表、 用户权限表，进行用户的登录与权限的判定。第 10 页概要设计说明书编写规范验证具体要求：1、用户 ID 只允许有数字、 字母、 下划线组成2、查找数据库中该用户 ID 所对应的密码是否与用户输入相同，并作出判断3、验证用户输入的验证与服务器中保存的 验证码 信息是 否一致 （保存 于Session 中的信息）课程安排：1、 得到学员所报的专业方向 （此处从数据库中学员信息表中取出学员报名时所选的专业方向） ，制定出学员的课程安排2、 再根据教师的专业方向 （同样从数据库中教师的信息表中得到教师的专业授课方向） ，制定出学员具体课程的上课教师名单3、 进行整理得到的课程（包括上课地点时间的具体信息）安排存入数据库中课程表中4、 学员选择查询信息后，系统根据学员选择的查询信息，到数据库中进行查询， 返回自己上课的课表， 具体课程的讲师、地点和时间安排。输出 登录：第 11 页概要设计说明书编写规范1、登录验证失败弹出警告框提示2、登录成功后进入学员课程查询界面课程安排：1、 操作出错时出现警告框的提示信息， 并说明出错的具体事项。2、 得到学员自己的课表信息， 包括具体的课程的讲师、 地点、和时间安排。表 3.3 教师授课安排功能需求描述功能 教师授课安排描述 教师通过登录本系统查看自己的上课安排，每们教师具有不同的上课安排，管理员根据教师的专业信息进行安排，并制作课表。输入 登录：1、 用户 ID2、密码3、验证码（与图片显示的验证码一致）授课安排：1、 选择查询某个时间段的授课安排2、 学员的专业方向3、 教师的属于什么专业第 12 页概要设计说明书编写规范处理 登录：1、输入用户 ID ，密码，验证码；先检验验证码是否合格，再检测数据库中的用户信息表， 用户类型表、 用户权限表， 进行用户的登录与权限的判定。验证具体要求：1、用户 ID 只允许有数字、字母、下划线组成2、查找数据库中该用户 ID 所对应的密码是否与用户输入相同，并作出判断3、验证用户输入的验证与服务器中保存的验证码信息是否一致（保存于 Session中的信息）课程安排：1、 得到学员所报的专业方向（此处从数据库中学员信息表中取出学员报名时所选的专业方向） ，制定出学员的课程安排2、 再根据教师的专业方向（同样从数据库中教师的信息表中得到教师的专业授课方向） ，制定出学员具体课程的上课教师名单3、 进行整理得到的课程（包括上课地点时间的具体信息）安排存入数据库中课程表中第 13 页概要设计说明书编写规范4、 教师选择查看自己上课的时间段，查看自己什么时间在什么地方上什么课的授课信息安排。输出 登录：1、登录验证失败弹出警告框提示2、登录成功后进入教师授课查询页面课程安排：1、 操作出错时出现警告框的提示信息，并说明出错的具体事项。2、 得到教师的授课安排（课程、地点、时间、上课的节数安排）。1.11 运行环境简要地说明对本系统的运行环境 （包括硬件环境和支持环境） 的规定， 详细说明参见 需求分析说明书 。硬件环境：服务器端建议使用专用服务器，客户建议配置 PII 以上的处理器， 64M 以上的内存。软件环境：服务器端使用 Windows 2003 sever +IIS +Sqlsever 2005 ，客户端使用普通的浏览器。本项包括在各种硬件约束下运行的软件要求，例如，应该包括：a 硬件配置的特点（接口数，指令系统等） ；第 14 页概要设计说明书编写规范b 内存储器和辅助存储器的容量 。c 有关详细信息如下 :电脑: 长城台式电脑操作系统 : Windows Server 2003硬件要求： CPU 系列：英特尔酷睿 i3 2 代系列CPU 型号： Intel 酷睿 i3 2760QMCPU 主频： 3.2GHz最高睿频： 3500MHz总线规格： DMI 5 GT/s三级缓存： 8MB核心类型： Sandy Bridge核心/线程数：四核心 /八线程制程工艺： 32nm 3.5 属性指令集： AVX ，32bit存储设备内存容量： 8GB内存类型： DDR3 1333MHz插槽数量： 2xSO-DIMM最大内存容量： 32GB硬盘容量： 1TB硬盘描述： 7200 转，SATA光驱类型： DVD 刻录机设计类型：光驱内置第 15 页概要设计说明书编写规范光驱描述：支持 DVD SuperMulti 双层刻录显示屏屏幕尺寸： 23 英寸屏幕比例： 16:9屏幕分辨率： 1920x1080背光技术： LED 背光纠错显卡显卡类型：独立显卡显卡芯片： NVIDIA GeForce GT 540M显存容量： 1GB显存类型： DDR3显存位宽： 128bit流处理器数量： 96DirectX ：11多媒体设备摄像头：集成摄像头音频系统：内置音效芯片扬声器：内置扬声器麦克风：内置麦克风网络通信无线网卡：支持 802.11b/g/n 无线协议有线网卡： 1000Mbps 以太网卡蓝牙：支持，蓝牙 3.0 模块I/O 接口数据接口： 1× USB2.0+2× USB3.0，e-SATA 接口， IEEE1394 接口视频接口： VGA，HDMI音频接口：耳机输出接口，麦克风输入接口第 16 页概要设计说明书编写规范其它接口： RJ45（网络接口） ，电源接口读卡器：多合 1 读卡器1.12 基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。客户 学员录课 教 个 报 取程 师 学人 成安 评 费信 绩名排 价 息招生部门 学员信息录取信息0教育培训系统授课安排教师工资教师信息教师管理部门学 学 费 课 学工 员 员 评 用 程 员资 成 信 价 信 安 信绩 息 息 排 息教师 学员管理部门第 17 页概要设计说明书编写规范第 18 页概要设计说明书编写规范1.13 功能需求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：本系统的功能结构如图：教育培训系统招 用 学 教生 户 员 师管 管 管 管理 理 理 理报名 用户管理 个人信息 授课安排 角色管理 成绩管理 个人信息录取日志管理 费用管理 工资管理课程安排 教师评价第 19 页概要设计说明书编写规范功能 描述此功能主要完成对学员的录取工作， 学员登录系统网站后，招生管理 可进行在线报名，填写报名信息，阅读协议提交。招生管理部门进行报名信息的筛选后，发放录取信息。超级管理员对系统内部的人员进行增加、修改、删除，对用户管理 人员、部门进行角色的分配。对学员的个人信息进行管理，成绩信息进行跟踪并查看与学员管理 统计，费用的计算与统计，对学员的上课进行安排，根据学员报名时所选的专业方向进行课程安排。教师管理 教师的个人信息的管理（修改和删除教师的信息） ，上课的安排，对教师工资的管理（包括奖金） ，管理学生对教师的评价信息。表 2.1 系统主要功能概述表 3.1 招生录取功能需求功能 招生录取描述 用户通过在线报名方式网上进行在线报名，填写报名信息，通过系统验收后，由招生管理工作人员进行报名信息的筛选并进行审核，审核通过后系统通知学员是否被录取，并发放录取公告。第 20 页概要设计说明书编写规范输入 登录 4、 用户 ID5、 密码6、 验证码（与图片显示的验证码一致）报名 9、 真实姓名（必填）10、 证件号（必填）11、 学历（必填）12、 电话（必填）13、 邮箱14、 报名方向（专业方向） （必填）15、 经历（学习或者工作）16、 同意合同协议（必须）录取 1、是否录取加工 登录： 1、输入用户 ID ，密码，验证码；先检验验证码是否合格，再检测数据库中的用户信息表，用户类型表、用户权限表，进行用户的登录与权限的判定。验证具体要求：1、用户 ID 只允许有数字、字母、下划线组成2、查找数据库中该用户 ID 所对应的密码是否与用户输入相同，并作出判断3、验证用户输入的验证与服务器中保存的第 21 页概要设计说明书编写规范验证码信息是否一致 （保存于 Session 中的信息）报名： 1、用户输入真实姓名，学历，电话，邮箱，经历，选择报名方向，同意合同协议，提交数据，先进行输入验证（填写是否符合要求，是否规范） ，验证全部通过后系统将提交的数据保存入数据库中。验证具体要求：1、姓名中不允许有特殊字符（例如“ * ”、“_”、“+”等）；2、电话号码只能为数字， 不允许出现字母与汉字。3、邮箱必须为合法的邮箱格式。4、必须选择你想学习的专业方向5、只有同意协议后才能报名录取：1、招生管理人员查看学员的报名信息（取出数据库中的数据） ，经过审核后，确认是否录取。2、录取后将录取学员的信息保存进数据库中。输出 登录： 1、登录验证失败弹出警告框提示2、登录成功后进入相应的权限页面第 22 页概要设计说明书编写规范报名：1、报名信息验证不正确时，进行相提示输入不正确，并将焦点显示在出错的位置上。2、确认同意协议后，系统弹出提示框请求用户再次确认。3、在报名时学员查看的协议（见附录一）录取： 1、显示录取的名单。从数据库取出录取学员的信息并显示。表 3.2 学员课程安排功能需求描述功能 学员课程安排描述 学员可以通过登录该网站在网上进行查询自己的个人课表，每个人根据自己所报的专业不一样课程也即不一样，授课教师也不一样，学员上课的课表由课程管理人员经过查看学员专业的方向和教师的信息后安排学员课程。输入 登录： 1、用户 ID2、密码3、验证码（与图片显示的验证码一致）课程安排：1、选择查询某个时间段的课程安排2、学员的专业方向3、教师的属于什么专业第 23 页概要设计说明书编写规范加工 登录：1、输入用户 ID ，密码，验证码；先检验验证码是否合格，再检测数据库中的用户信息表， 用户类型表、 用户权限表，进行用户的登录与权限的判定。验证具体要求：1、用户 ID 只允许有数字、 字母、 下划线组成2、查找数据库中该用户 ID 所对应的密码是否与用户输入相同，并作出判断3、验证用户输入的验证与服务器中保存的 验证码 信息是 否一致 （保存 于Session 中的信息）课程安排：5、 得到学员所报的专业方向 （此处从数据库中学员信息表中取出学员报名时所选的专业方向） ，制定出学员的课程安排6、 再根据教师的专业方向 （同样从数据库中教师的信息表中得到教师的专业授课方向） ，制定出学员具体课程的上课教师名单7、 进行整理得到的课程（包括上课地点时间的具体信息）安排存入数据库中课程表中第 24 页概要设计说明书编写规范8、 学员选择查询信息后，系统根据学员选择的查询信息，到数据库中进行查询， 返