概要设计说明书

概要设计说明书编写规范 案卷号案卷号 日期日期 XX 集团网络化运营系统 概要设计说明书概要设计说明书 作 者 王立峰 完成日期 2000 11 3 签 收 人 签收日期 修改情况记录 版本号修改批准人修改人安装日期签收人 概要设计说明书编写规范 目录目录 1 引言引言 1 1 1 编写目的 1 1 2 范围 1 1 3 定义 1 1 4 参考资料 4 2 总体设计总体设计 5 2 1 需求规定 5 2 2 运行环境 5 2 3 基本设计概念和处理流程 6 2 4 结构 6 2 5 功能需求与程序的关系 6 2 6 人工处理过程 6 2 7 尚未解决的问题 6 3 接口设计接口设计 7 3 1 用户接口 7 3 2 外部接口 7 3 3 内部接口 7 4 运行设计运行设计 7 4 1 运行模块组合 7 4 2 运行控制 7 4 3 运行时间 7 5 系统数据结构设计系统数据结构设计 8 5 1 逻辑结构设计要点 8 5 2 物理结构设计要点 8 5 3 数据结构与程序的关系 8 6 系统出错处理设计系统出错处理设计 9 6 1 出错信息 9 6 2 补救措施 9 6 3 系统维护设计 9 概要设计说明书编写规范 第 1 页 1 引言引言 1 1 编写目的编写目的 本概要设计说明书根据 教育培训系统需求规格说明书 编写 描述了系统的概要设 计 并为下一步的 系统详细设计说明书 的编写提供依据 为系统测试人员提供测试依 据 本文档的预期读者 项目经理 系统分析员 测试经理 项目组长 系统开发人员 1 2 范围范围 教育培训系统 本系统主要实现学员登录报名与录取管理 学员和教师的管理 课程的管理 费用管 理 其它功能暂时不会涉及 本系统为了开展上述工作而设计了组织机构的设置 管理角色的设置 会员的管理设 置 本系统为了对成绩的管理而编制了各项的统计报表 本系统实现对学员信息 成绩 课程的管理 比如增加 删除 修改等功能 本系统实现对教师信息 课程的管理 比如增加 删除 修改等功能 本系统实现对管理员管理 管理员实现对学员信息 教师信息的后台管理 项目提出者 吴光成老师 项目开发者 朱磊 蒲勇 岳潇潇 童谣 马三茜 项目用户单位 XXXX 培训机构 1 3 定义定义 HTTP HyperText Transfer Protocol 超文本传送协议 一种详细规定了浏览器和万维 网服务器之间互相通信的规则 通过因特网传送万维网文档的数据传送协议 HTML 超文本标记语言 即 HTML Hypertext Markup Language 是用于描述网页 文档的一种标记语言 概要设计说明书编写规范 第 2 页 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 处理器开发 概要设计说明书编写规范 第 3 页 的总线标准 它是建立 PCI 总线基础上 专门针对 3D 图形处理而开发的高效能总线 AGP 的插槽与 PCI 不兼容 AGP 的显示卡不能插在 PCI 总线上 AGP 插槽比 PCI 要短 AGP 最大的改进是达到了 133MHz 以上的数据传输速率 数据吞吐速度可以达到 533MB 秒以上 由于达到了这么高的传输速率 便可以将图形内存中的数据调入系统内 存 从而大大地减轻图形内存的压力 JavaScript JavaScript 是一种新的描述语言 此种语言可以被嵌入 HTML 的文件之中 通过 JavaScript 可以做到处理访问者的需求事件 如 表单的输入 而不用向网络来回 传资料 所以 当访问者输入信息时 信息不用经过传给服务器处理之后 再传回来的过 程 而是直接可以被客户端 client 的应用程序处理 LAN 局域网 局域网是一种小型网 3 至 50 个节点 通常布置在一个公司 或组织 的 办公区域内 确切地说 局域网只是与广域网相对应的一个词 并没有严格的定义 凡是 小范围内的有限个通信设备互联在一起的通信网都可以称为局域网 这里的通信设备可以 包括微型计算机 终端 外部设备 电话机 传真机等 按照这种说法 专用小型交换机 PBX Private Branch eXchange 也是一种局域网 而我们通常所说的都是计算机局部网络 简称为局域网 防火墙 防火墙是连接区域网路和互联网供应商路由器的 桥梁 电脑 这些硬件专门 设计用来拦截并过滤信息 只让符合严格安全标准的信息通过 防火墙一般可以分为两大 类 网络层级和应用程式层级 格式化 指对磁盘进行使用前的预处理以便存入数据 一般而言 新盘是必须格式化的 而使用过的旧盘也可以格式化 格式化后磁盘上全部数据将被删除 模块化 按照功能将一个软件切分成许多部分单独开发 然后再组装起来 每一个部分即 为模块 其优点是利于控制质量 利于多人合作 利于扩充功能等 是软件工程中一种重要 的开发方法 分辨率 Resolution 影象清晰度或浓度的度量标准 举例来说 分辨率代表垂直 概要设计说明书编写规范 第 4 页 及水平显示的每英寸点 dpi 的数量 BitWare 可以用普通或标准 100 乘 200 dpi 及 精细分辨率 200 乘 200 dpi 发送及接收传真文档 数据字典 Data dictionary 是一种用户可以访问的记录数据库和应用程序源数据的 目录 主动数据字典是指在对数据库或应用程序结构进行修改时 其内容可以由 DBMS 自 动更新的数据字典 被动数据字典是指修改时必须手工更新其内容的数据字典 MSDN 全称是 Microsoft Developer Network 这是微软公司面向软件开发者的一种 信息服务 MSDN 实际上是一个以 Visual Studio 和 Windows 平台为核心整合的开发虚 拟社区 包括技术文档 在线电子教程 网络虚拟实验室 微软产品下载 几乎全部的操 作系统 服务器程序 应用程序和开发程序的正式版和测试版 还包括各种驱动程序开发 包和软件开发包 Blog BBS MSDN WebCast 与 CMP 合作的 MSDN 杂志等等一系 列服务 约束 数据属性的特性 用于指明服务 如 写数值 读数值 取代等服务可应用该 数据属性特性 报表 企业管理的基本措施和途径 是企业的基本业务要求 简单的说 报表就是用 表格 图表等格式来动态显示数据 可以用公式表示为 报表 多样的格式 动态的 数据 服务器 指一个管理资源并为用户提供服务的计算机软件 通常分为文件服务器 数 据库服务器和应用程序服务器 运行以上软件的计算机或计算机系统也被称为服务器 类图 UML 时序图 概要设计说明书编写规范 第 5 页 1 4 参考资料参考资料 列出要用到的参考资料 如 a 本项目的经核准的计划任务书或合同 上级机关的批文 b 属于本项目的其他已发表的文件 c 本文件中各处引用的文件 资料 包括所要用到的软件开发标准 列出这些文件的标题 文件编号 发表日期和出版单位 说明能够得到这些文件资料 的来源 教育培训系统需求说明书 概要设计说明书编写规范 教育培训系统计划任务书 教育培训系统合同 教育培训系统机关批文 系统分析与设计 机械工业出版社出版 2010 年 4 月 美 Kenneth E Kendall Julie E Kendall 著 施平安 郝清赋 译 MSDN 文档 教育研究方法导论 安徽教育出版社 1999 年版 2009 年印刷 裴娣娜著 教育学基础 第二版 教育科学出版社 全国十二所重点师范大学联合编写 教育学 人民教育出版社 1999 年第三版 王道俊 王汉澜著 教育学基础 第二版 教育科学出版社 全国十二所重点师范大学联合编写 概要设计说明书编写规范 第 6 页 2 总体设计总体设计 2 1 需求规定需求规定 说明对本系统的主要的输入输出项目 处理的功能性能要求 详细的说明可参见 需 求分析说明书 需求描述如下表 需求描述如下表 表 3 1招生录取功能需求 功能招生录取 描述用户通过在线报名方式网上进行在线报名 填写报名信息 通过 系统验收后 由招生管理工作人员进行报名信息的筛选并进行审核 审核通过后系统通知学员是否被录取 并发放录取公告 登录1 用户 ID 2 密码 3 验证码 与图片显示的验证码一致 输入 报名1 真实姓名 必填 2 证件号 必填 3 学历 必填 4 电话 必填 5 邮箱 概要设计说明书编写规范 第 7 页 6 报名方向 专业方向 必填 7 经历 学习或者工作 8 同意合同协议 必须 录取 1 是否录取 处理登录 1 输入用户 ID 密码 验证码 先检验验证码是否合格 再 检测数据库中的用户信息表 用户类型表 用户权限表 进行用户的登录与权限的判定 验证具体要求 1 用户 ID 只允许有数字 字母 下划线 组成 2 查找数据库中该用户 ID 所对应的密码 是否与用户输入相同 并作出判断 3 验证用户输入的验证与服务器中保存的 验证码信息是否一致 保存于 Session 中的信息 报名 1 用户输入真实姓名 学历 电话 邮箱 经历 选择报名 方向 同意合同协议 提交数据 先进行输入验证 填写 是否符合要求 是否规范 验证全部通过后系统将提交 的数据保存入数据库中 概要设计说明书编写规范 第 8 页 验证具体要求 1 姓名中不允许有特殊字符 例如 等 2 电话号码只能为数字 不允许出现字 母与汉字 3 邮箱必须为合法的邮箱格式 4 必须选择你想学习的专业方向 5 只有同意协议后才能报名 录取 1 招生管理人员查看学员的报名信息 取出数据库中的数据 经过审核后 确认是否录取 2 录取后将录取学员的信息保存进数据库中 输出登录 1 登录验证失败弹出警告框提示 2 登录成功后进入相应的权限页面 报名 1 报名信息验证不正确时 进行相提示输入不正确 并将焦 点显示在出错的位置上 2 确认同意协议后 系统弹出提示框请求用户再次确认 3 在报名时学员查看的协议 见附录一 录取 1 显示录取的名单 从数据库取出录取学员的信息并显示 概要设计说明书编写规范 第 9 页 招生录取数据流图 招生录取数据流图 图 3 4招生录取数据流图 课程管理用例图 课程管理用例图 报名信息 1 1 填写报名 信息 报名信息 1 2 信息审核 D1 报名信息审核通过信息 2 1 筛选信息 报名信息 1 3 报名信息 统计查询 报名信息 统计信息 筛选条件 筛选后的信息 2 2 录取合格者 2 3 发放通知 录取信息 通知 课课程程管管理理 学员 教师 课程安排 培训管理人员 端19 端20 端21 端22 学员课程安排 教师授课安排 端23 端24 端25 端26 端27 端28 概要设计说明书编写规范 第 10 页 图 3 5课程管理用例图 课程管理需求描述 课程管理需求描述 表 3 2学员课程安排功能需求描述 功能学员课程安排 描述学员可以通过登录该网站在网上进行查询自己的个人课表 每个 人根据自己所报的专业不一样课程也即不一样 授课教师也不一样 学员上课的课表由课程管理人员经过查看学员专业的方向和教师的信 息后安排学员课程 输入登录 1 用户 ID 2 密码 3 验证码 与图片显示的验证码一致 课程安排 1 选择查询某个时间段的课程安排 2 学员的专业方向 3 教师的属于什么专业 处理登录 1 输入用户 ID 密码 验证码 先检验验证码是否合格 概要设计说明书编写规范 第 11 页 再检测数据库中的用户信息表 用户类型表 用户权限 表 进行用户的登录与权限的判定 验证具体要求 1 用户 ID 只允许有数字 字母 下划 线组成 2 查找数据库中该用户 ID 所对应的密 码是否与用户输入相同 并作出判 断 3 验证用户输入的验证与服务器中保 存的验证码信息是否一致 保存于 Session 中的信息 课程安排 1 得到学员所报的专业方向 此处从数据库中学员信息 表中取出学员报名时所选的专业方向 制定出学员的 课程安排 2 再根据教师的专业方向 同样从数据库中教师的信息 表中得到教师的专业授课方向 制定出学员具体课程 的上课教师名单 3 进行整理得到的课程 包括上课地点时间的具体信息 安排存入数据库中课程表中 4 学员选择查询信息后 系统根据学员选择的查询信息 概要设计说明书编写规范 第 12 页 到数据库中进行查询 返回自己上课的课表 具体课 程的讲师 地点和时间安排 输出登录 1 登录验证失败弹出警告框提示 2 登录成功后进入学员课程查询界面 课程安排 1 操作出错时出现警告框的提示信息 并说明出错的具 体事项 2 得到学员自己的课表信息 包括具体的课程的讲师 地点 和时间安排 表 3 3教师授课安排功能需求描述 功能教师授课安排 描述 教师通过登录本系统查看自己的上课安排 每们教师具有不同的 上课安排 管理员根据教师的专业信息进行安排 并制作课表 输入登录 1 用户 ID 2 密码 3 验证码 与图片显示的验证码一致 授课安排 1 选择查询某个时间段的授课安排 概要设计说明书编写规范 第 13 页 2 学员的专业方向 3 教师的属于什么专业 处理登录 1 输入用户 ID 密码 验证码 先检验验证码是否合格 再 检测数据库中的用户信息表 用户类型表 用户权限表 进行用户的登录与权限的判定 验证具体要求 1 用户 ID 只允许有数字 字母 下划线 组成 2 查找数据库中该用户 ID 所对应的密码 是否与用户输入相同 并作出判断 3 验证用户输入的验证与服务器中保存 的验证码信息是否一致 保存于 Session 中的信息 课程安排 1 得到学员所报的专业方向 此处从数据库中学员信息表 中取出学员报名时所选的专业方向 制定出学员的课 程安排 2 再根据教师的专业方向 同样从数据库中教师的信息表 中得到教师的专业授课方向 制定出学员具体课程的 概要设计说明书编写规范 第 14 页 上课教师名单 3 进行整理得到的课程 包括上课地点时间的具体信息 安排存入数据库中课程表中 4 教师选择查看自己上课的时间段 查看自己什么时间在 什么地方上什么课的授课信息安排 输出登录 1 登录验证失败弹出警告框提示 2 登录成功后进入教师授课查询页面 课程安排 1 操作出错时出现警告框的提示信息 并说明出错的具体 事项 2 得到教师的授课安排 课程 地点 时间 上课的节数 安排 2 2 运行环境运行环境 简要地说明对本系统的运行环境 包括硬件环境和支持环境 的规定 详细说明参见 需求分析说明书 硬件环境 服务器端建议使用专用服务器 客户建议配置 PII 以上的处理器 64M 以 上的内存 软件环境 服务器端使用 Windows 2003 sever IIS Sql sever 2005 客户端使用普通的 概要设计说明书编写规范 第 15 页 浏览器 本项包括在各种硬件约束下运行的软件要求 例如 应该包括 a 硬件配置的特点 接口数 指令系统等 b 内存储器和辅助存储器的容量 c 有关详细信息如下 电脑 长城 台式电脑 操作系统 Windows Server 2003 硬件要求 CPU 系列 英特尔 酷睿 i3 2 代系列 CPU 型号 Intel 酷睿 i3 2760QM CPU 主频 3 2GHz 最高睿频 3500MHz 总线规格 DMI 5 GT s 三级缓存 8MB 核心类型 Sandy Bridge 核心 线程数 四核心 八线程 制程工艺 32nm 3 5 属性 指令集 AVX 32bit 存储设备 内存容量 8GB 内存类型 DDR3 1333MHz 插槽数量 2xSO DIMM 最大内存容量 32GB 硬盘容量 1TB 概要设计说明书编写规范 第 16 页 硬盘描述 7200 转 SATA 光驱类型 DVD 刻录机 设计类型 光驱内置 光驱描述 支持 DVD SuperMulti 双层刻录 显示屏 屏幕尺寸 23 英寸 屏幕比例 16 9 屏幕分辨率 1920 x1080 背光技术 LED 背光 纠错 显卡 显卡类型 独立显卡 显卡芯片 NVIDIA GeForce GT 540M 显存容量 1GB 显存类型 DDR3 显存位宽 128bit 流处理器数量 96 DirectX 11 多媒体设备 摄像头 集成摄像头 音频系统 内置音效芯片 扬声器 内置扬声器 麦克风 内置麦克风 网络通信 无线网卡 支持 802 11b g n 无线协议 有线网卡 1000Mbps 以太网卡 蓝牙 支持 蓝牙 3 0 模块 概要设计说明书编写规范 第 17 页 I O 接口 数据接口 1 USB2 0 2 USB3 0 e SATA 接口 IEEE1394 接口 视频接口 VGA HDMI 音频接口 耳机输出接口 麦克风输入接口 其它接口 RJ45 网络接口 电源接口 读卡器 多合 1 读卡器 2 3 基本设计概念和处理流程基本设计概念和处理流程 说明本系统的基本设计概念和处理流程 尽量使用图表的形式 0 教育培训系统 招生部门学员信息 录取信息 学员 学 费 成 绩 课 程 安 排 学员管理部门 课 程 安 排 学 员 信 息 教师 管理 部门 授课安排 教 师 评 价 教师信息 教师 工 资 教师工资 学 员 信 息 评 价 个 人 信 息 客户 报 名 费 用 信 息 学 员 成 绩 录 取 概要设计说明书编写规范 第 18 页 概要设计说明书编写规范 第 19 页 2 4 功能需求与程序的关系功能需求与程序的关系 本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系 本系统的功能结构如图 教育培训系统 招 生 管 理 用 户 管 理 学 员 管 理 教 师 管 理 报名 录取 用户管理 角色管理 日志管理 日志管理 日志管理 个人信息 成绩管理 费用管理 费用管理 课程安排 授课安排 个人信息 工资管理 教师评价 概要设计说明书编写规范 第 20 页 功能功能描述描述 招生管理 此功能主要完成对学员的录取工作 学员登录系统网站后 可进行在线报名 填写报名信息 阅读协议提交 招生管理部 门进行报名信息的筛选后 发放录取信息 用户管理 超级管理员对系统内部的人员进行增加 修改 删除 对 人员 部门进行角色的分配 学员管理 对学员的个人信息进行管理 成绩信息进行跟踪并查看与 统计 费用的计算与统计 对学员的上课进行安排 根据学员 报名时所选的专业方向进行课程安排 教师管理教师的个人信息的管理 修改和删除教师的信息 上课 的安排 对教师工资的管理 包括奖金 管理学生对教师的 评价信息 表 2 1系统主要功能概述 表 3 1招生录取功能需求 功能招生录取 描述用户通过在线报名方式网上进行在线报名 填写报名信息 通过 系统验收后 由招生管理工作人员进行报名信息的筛选并进行审核 审核通过后系统通知学员是否被录取 并发放录取公告 概要设计说明书编写规范 第 21 页 登录4 用户 ID 5 密码 6 验证码 与图片显示的验证码一致 报名9 真实姓名 必填 10 证件号 必填 11 学历 必填 12 电话 必填 13 邮箱 14 报名方向 专业方向 必填 15 经历 学习或者工作 16 同意合同协议 必须 输入 录取 1 是否录取 加工登录 1 输入用户 ID 密码 验证码 先检验验证码是否合格 再 检测数据库中的用户信息表 用户类型表 用户权限表 进行用户的登录与权限的判定 验证具体要求 1 用户 ID 只允许有数字 字母 下划线 组成 2 查找数据库中该用户 ID 所对应的密码 是否与用户输入相同 并作出判断 3 验证用户输入的验证与服务器中保存的 概要设计说明书编写规范 第 22 页 验证码信息是否一致 保存于 Session 中的信息 报名 1 用户输入真实姓名 学历 电话 邮箱 经历 选择报名 方向 同意合同协议 提交数据 先进行输入验证 填写 是否符合要求 是否规范 验证全部通过后系统将提交 的数据保存入数据库中 验证具体要求 1 姓名中不允许有特殊字符 例如 等 2 电话号码只能为数字 不允许出现字 母与汉字 3 邮箱必须为合法的邮箱格式 4 必须选择你想学习的专业方向 5 只有同意协议后才能报名 录取 1 招生管理人员查看学员的报名信息 取出数据库中的数据 经过审核后 确认是否录取 2 录取后将录取学员的信息保存进数据库中 输出登录 1 登录验证失败弹出警告框提示 2 登录成功后进入相应的权限页面 概要设计说明书编写规范 第 23 页 报名 1 报名信息验证不正确时 进行相提示输入不正确 并将焦 点显示在出错的位置上 2 确认同意协议后 系统弹出提示框请求用户再次确认 3 在报名时学员查看的协议 见附录一 录取 1 显示录取的名单 从数据库取出录取学员的信息并显示 表 3 2学员课程安排功能需求描述 功能学员课程安排 描述学员可以通过登录该网站在网上进行查询自己的个人课表 每个 人根据自己所报的专业不一样课程也即不一样 授课教师也不一样 学员上课的课表由课程管理人员经过查看学员专业的方向和教师的信 息后安排学员课程 输入登录 1 用户 ID 2 密码 3 验证码 与图片显示的验证码一致 课程安排 1 选择查询某个时间段的课程安排 2 学员的专业方向 3 教师的属于什么专业 概要设计说明书编写规范 第 24 页 加工登录 1 输入用户 ID 密码 验证码 先检验验证码是否合格 再检测数据库中的用户信息表 用户类型表 用户权限 表 进行用户的登录与权限的判定 验证具体要求 1 用户 ID 只允许有数字 字母 下划 线组成 2 查找数据库中该用户 ID 所对应的密 码是否与用户输入相同 并作出判 断 3 验证用户输入的验证与服务器中保 存的验证码信息是否一致 保存于 Session 中的信息 课程安排 5 得到学员所报的专业方向 此处从数据库中学员信息 表中取出学员报名时所选的专业方向 制定出学员的 课程安排 6 再根据教师的专业方向 同样从数据库中教师的信息 表中得到教师的专业授课方向 制定出学员具体课程 的上课教师名单 7 进行整理得到的课程 包括上课地点时间的具体信息 概要设计说明书编写规范 第 25 页 安排存入数据库中课程表中 8 学员选择查询信息后 系统根据学员选择的查询信息 到数据库中进行查询 返回自己上课的课表 具体课 程的讲师 地点和时间安排 输出登录 1 登录验证失败弹出警告框提示 2 登录成功后进入学员课程查询界面 课程安排 3 操作出错时出现警告框的提示信息 并说明出错的具 体事项 4 得到学员自己的课表信息 包括具体的课程的讲师 地点 和时间安排 表 3 3教师授课安排功能需求描述 功能教师授课安排 描述 教师通过登录本系统查看自己的上课安排 每们教师具有不同的 上课安排 管理员根据教师的专业信息进行安排 并制作课表 输入登录 2 用户 ID 2 密码 3 验证码 与图片显示的验证码一致 概要设计说明书编写规范 第 26 页 授课安排 4 选择查询某个时间段的授课安排 5 学员的专业方向 6 教师的属于什么专业 加工登录 1 输入用户 ID 密码 验证码 先检验验证码是否合格 再 检测数据库中的用户信息表 用户类型表 用户权限表 进行用户的登录与权限的判定 验证具体要求 1 用户 ID 只允许有数字 字母 下划线 组成 2 查找数据库中该用户 ID 所对应的密码 是否与用户输入相同 并作出判断 3 验证用户输入的验证与服务器中保存 的验证码信息是否一致 保存于 Session 中的信息 课程安排 5 得到学员所报的专业方向 此处从数据库中学员信息表 中取出学员报名时所选的专业方向 制定出学员的课 程安排 概要设计说明书编写规范 第 27 页 6 再根据教师的专业方向 同样从数据库中教师的信息表 中得到教师的专业授课方向 制定出学员具体课程的 上课教师名单 7 进行整理得到的课程 包括上课地点时间的具体信息 安排存入数据库中课程表中 8 教师选择查看自己上课的时间段 查看自己什么时间在 什么地方上什么课的授课信息安排 输出登录 1 登录验证失败弹出警告框提示 2 登录成功后进入教师授课查询页面 课程安排 3 操作出错时出现警告框的提示信息 并说明出错的具体 事项 4 得到教师的授课安排 课程 地点 时间 上课的节数 安排 表 3 4学员管理功能需求描述 功能学员管理 描述以前管理学员很不方便 每个学员都有很多的信息需要整理 需要动用很大的人力物力才能办到 学员的费用信息管理也有很 概要设计说明书编写规范 第 28 页 多的不足 管理起来很不方便 成绩也是 本系统提供学员的一 般管理 包括学员个人信息的管理 学员的费用管理 学员的成 绩的管理 大大提高了教育培训机构对学员的管理 不用再用很 多的人力物力去管理 个人信息管理可以对学员的个人信息进行添加 更新与删除 费用管理可以统计学员的交费情况 成绩的管理 1 学员查看自己的成绩 2 教师查看学员的成绩 3 管理员管理学员的成绩 输入 1 个人信息 需要添加和修改的信息 2 成绩 学员编号非空 学员姓名 专业方向非空 学员成绩非空 3 费用 学员编号非空 学员姓名 概要设计说明书编写规范 第 29 页 专业方向非空 交费日期交费时存入 交费情况 是 否已交 非空 加工个人信息 1 检查学员输入的信息是否合法 验证要求 1 姓名中不允许有特殊字符 例如 等 2 电话号码只能为数字 不允许出现 字母与汉字 3 邮箱必须为合法的邮箱格式 4 必须选择你想学习的专业方向 5 只有同意协议后才能报名 2 获取验证成功的数据 更新学员的信息保存入数据库 成绩管理 1 将输入的成绩保存到数据库 2 根据学员的编号到数据库中查询出某个学员的成绩 情况 3 根据专业的信息到数据库中查询出该专业学员的成 绩总体情况与每个学员的具体情况信息 概要设计说明书编写规范 第 30 页 费用管理 1 将输入的学员费用信息保存到数据库中 2 根据学员的编号查询学员的交费情况 3 从数据库中取出学员交费具体情况进行统计得出学 员的交费情况 输出个人信息 1 修改 添加学员信息的时候 点击保存时 弹出 确认保存的对话框提示用户是否确认添加或修改 些信息 2 修改或者添加成功后提示成功 3 验证进出现错误时 进行相提示输入不正确 并 将焦点显示在出错的位置上 成绩管理 1 根据学员的编号得到学员个人的具体成绩 2 根据专业编号得到该专业的总体成绩报告 也可以 在其中查询某个学员的成绩情况 可以通过浏览来 得到 也可以通过索引的方式输入学员的信息来查 询学员的个人成绩信息 3 学员 教师 管理员根据权限的不同返回不同的信 息页面信息 费用管理 1 显示学员的交费情况 通过学员的编号信息或者学 概要设计说明书编写规范 第 31 页 员的姓名来查询 不同权限的人得到不同的信息 学员自己只能查看自己的信息 管理员可以查询学 员整体的交费情况 表 3 5评价反馈功能需求描述 功能 评价反馈 描述学员可以对教师的专业水平信息 上课情况 课后辅导进行 评价 采用打分的方式进行 教师 学员 管理者都可以查看学 员对教师的评价 输入1 教师的专业水平评价 2 教师的上课情况进行评价 3 教师的课后辅导时行评价 加工1 对教师的评价进行审核 2 对教师的评价分类整理 好评与差评 3 得到教师的评价信息后 将其存入到数据库中 4 通过教师的编号或者是姓名 从数据库中获取教师的评 价信息 查询 5 管理教师的评价信息 输出1 查看教师信息时 可以查看到学员对教师的评价信息 2 评价完毕提交提示是否确认提交操作 表 3 6工资发放功能需求描述 概要设计说明书编写规范 第 32 页 功能工资发放 描述教师通过系统了解这个月的工资 奖金 以及扣除的工资发 放 并且可以查看这个月工资总和 输入1 教师的编号 2 教师的姓名 3 是否已经发放工资 4 管理员确认发入工资 5 教师填写银行卡号 6 时间段 主要查询工资的历史情况 加工1 总工资 基础工资 加班所得 奖金 应扣除的罚金 个 人所得税 2 将工资的具体情况存入到数据库中 3 统计工资情况 4 确认发放工资后 通过银行接口将工资发放到员工的银 行卡上 5 可以修改自己的银行卡号 将修改的卡号信息存入到数 据库 输出1 点击发放工资时 提示确认信息 2 操作出错时 有相应的错误信息的提示 3 修改自己的信息时 提示是否确认修改信息 修改成功 后有相应的成功提示 4 查看自己的工资发放情况 包括有基础工资 加班工资 概要设计说明书编写规范 第 33 页 奖金 迟到扣掉或者其它原因扣除掉的工资 5 管理员得到教师的工资发放情况 哪些已经发放 哪些 还未发放 未发放的有深色标记并在表的前面显示出来 表 3 7教师管理功能需求描述 功能教师管理 描述 对教师的信息进行管理 添加 修改 删除 输入1 自己的简历 2 有的成就 3 个人的基本信息 例如 姓名 年龄 特长等进行添加 修改 4 进行删除自己的信息时点击确定 否则选择取消 加工1 检查教师输入的信息是否合法 验证要求 1 姓名中不允许有特殊字符 例如 等 2 电话号码只能为数字 不允许出 现字母与汉字 3 邮箱必须为合法的邮箱格式 4 必须选择你想学习的专业方向 5 只有同意协议后才能报名 概要设计说明书编写规范 第 34 页 2 获取验证成功的数据 更新教师的信息保存入数据 库 输出1 修改 添加教师信息的时候 点击保存时 弹出确认保 存的对话框提示用户是否确认添加或修改些信息 2 修改或者添加成功后提示成功 3 验证进出现错误时 进行相提示输入不正确 并将焦点 显示在出错的位置上 表 3 8用户管理功能需求表 功能 用户管理 描述 系统管理员对整个系统的用户进行添加 修改 删除进行管理用 户 并给不同的用户分配不同的权限来进行系统的操作 主要对系统 有着维护工作 输入登录 1 管理员 ID 2 密码 3 验证码 与图片显示的验证码一致 管理用户 1 用户 ID 2 用户密码 3 角色 概要设计说明书编写规范 第 35 页 4 权限 加工登录 1 输入管理员 ID 密码 验证码 先检验验证码是否合格 再检测数据库中的管理员信息表 验证具体要求 1 用户 ID 只允许有数字 字母 下划 线组成 2 查找数据库中该管理员 ID 所对应的 密码是否与管理员输入相同 并作 出判断 3 验证用户输入的验证与服务器中保 存的验证码信息是否一致 保存于 Session 中的信息 用户管理 1 为不同的角色分配不同的权限 将角色信息保存到数据 库中 2 将输入的用户 确认之后保存到数据库中的用户表中 并进行管理 具有添加 修改 删除的权限 3 查询用户的信息 从数据库中用户表中查询 输出1 管理员登录成功后进入相应的用户管理界面 概要设计说明书编写规范 第 36 页 2 用户添加 修改 删除成功后提示保存成功 3 角色添加 修改成功后提示成功 4 用户表的信息 2 5 人工处理过程人工处理过程 说明在本软件系统的工作过程中不得不包含的人工处理过程 如果有的话 2 6 尚未解决的问题尚未解决的问题 说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题 关于用户如何通过网络环境缴费和发放工资的问题目前还没有技术能力解决 3 接口设计接口设计 3 1 用户接口用户接口 说明将向用户提供的命令和它们的语法结构 以及软件的回答信息 a 建立和清除连接 发送和接受数据 发送中断信息 控制出错 生成状态报告 b 用户通过在程序中使用系统调用命令来请求操作系统提供服务 c 为了便于用户直接间接控制自己的作业 操作系统向用户提供了命令接口 有利 于操作系统命令组织和控制作业 在命令输入界面上输入 有系统在后台执行 并将结果反映到前台界面或特定的文件内 d 用户可以通过鼠标菜单和对话框来完成对应程序和文件的操作 概要设计说明书编写规范 第 37 页 用户接口 语法结构 软件回答信息 招生管理员登陆 以英文和汉字开头 不 超过 6 个字符 进入招生管理界面 课程管理员登陆以英文和汉字开头 不超 过 6 个字符 进入课程管理界面 考勤调查管理进行相应的操作 教师管理员登陆以英文和汉字开头 不超 过 6 个字符 进入教师管理界面 管理员登陆以英文和汉字开头 不超 过 6 个字符 进入学员管理界面和考试 管理界面以及新闻邮件管 理界面 3 2 外部接口外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口 本系统与各支持软 件之间的接口关系 3 2 1 用户接口用户接口 提供用户使用软件产品时的接口需求 例如 如果系统的用户通过显示终端进行操作 就必须指定如下要求 a 对屏幕格式的要求 标准屏幕 1024 768 宽屏屏幕 1366 768 b 报表或菜单的页面打印格式和内容 由客户提供现有报表并加以改进 c 输入输出的相对时间 一切时间以服务器时间为基准 d 程序功能键的可用性 通过鼠标完成所有操作 e 用户界面的要求 概要设计说明书编写规范 第 38 页 用户界面友好 容易学习 理解 操作方便 简单 采用一般系统都采用的暗色调 当出现错误操作时 采用警告框进行提示 当关闭或者进行删除等操作时 采用确认框 向用户再次确认是否执行此操作 字体和控件的组织搭配要得体 3 2 2 硬件接口硬件接口 1 带有终端显示的计算机 例如 PC 机 笔记本电脑 台式机等都可以 但不支持 移动终端设备 2 分辨率为 1024 768 以及以上 3 网卡 Network Interface Card 也称为网络适配器或网板 它负责计算机与网 络介质之间的电气连接 数据流的传输和网络地址确认 4 集线器 是连接是连接网络上各个结点的一种装置 当网络的某个结点发生故障 时 连接在集线器上的结点立即可以检测到 而且不影响网络上其他结点的正常工作 有 利于网络的维护和故障排除 5 网桥 网桥是一种存储转发设备 主要用来连接类型相似的局域网络 6 路由器 是连接两个或更多个逻辑上相互独立的子网 工作在 ISO OSI 的第三层 即网络层 7 网关 又称协议转换器 它负责将协议进行转换并且保留原有的功能 将数据重 新分组 以便在两个协议不同的网络之间进行通信 网关工作在 OSI 协议的传送层或更高 层 主要用于连接不同结构体系的网络或用于局域网与主机之间的连接 8 中继器 是最简单的局域网延伸设备 运行在物理层 即 OSI 的最底层 3 2 3 软件接口软件接口 1 数据库服务器 a 名称 SQL Server 2005 b 别名 Microsoft Sql Server 2005 Enterprise 概要设计说明书编写规范 第 39 页 c 规格说明号 d 版本号 2005 e 来源 微软中国 2 操作系统 a 名称 Windows xp 及以上版本 b 别名 Microsoft windows os c 规格说明号 d 版本号 e 来源 微软中国 对于每一个接口 这部分应说明与软件产品相关的接口软件的目的 并根据信息的内 容和格式定义接口 但不必详细描述任何已有完整文件的接口 只要引用定义该接口的文 件即可 3 2 4 通信接口通信接口 1 HTTP 是客户端浏览器或其他程序与 Web 服务器这间的应用层通信协议 在 Internet 上的 Web 服务器上存放的都是超文本信息 客户机需要通过 HTTP 协议传输所要 访问的超文本信息 HTTP 包含命令和传输信息 不仅可用于 Web 访问 也可用于其他因 特网 内联网应用系统这间的通信 从而实现各类应用资源超媒体访问的集成 2 TCP IP 这个协议是 Internet 最基本的协议 Internet 国际互联网的基础 简单地说 就是由网络层的 IP 协议和传输层的 TCP 协议组成的 TCP IP 定义了电子设备 比如计算 机 如何连入因特网 以及数据如何在它们之间传输的标准 TCP IP 是一个四层的分层体 系结构 高层为传输控制协议 它负责聚集信息或文件拆分成更小的包 底层是网际协议 它处理每个包的地址部分 使这些包正确的到达目的地 3 建议采用 IE6 0 及以上版本 Firefox chrome 概要设计说明书编写规范 第 40 页 3 3 内部接口内部接口 说明本系统之内的各个系统元素之间的接口的安排 概要设计说明书编写规范 第 41 页 User User in UserID int in UserName string in Password string in Email string in PasswordQuestion string in PasswordAnswer string in RoleId int UserID int UserName string Password string Email string PasswordQuestion string PasswordAnswer string RoleId int U Us se er r GetUserById in UserId int User GetAllUser User DelUserById in userId int int UpdateUser in userId int int GetUserCount int AddUser in userid int in username string in email string in passwordquestion string in password string in passwordanswer string in roleid int int U Us se er rS Se er rv vi ic ce e Role Role in RoleId int in RoleName string RoleId int RoleName string R Ro ol le e GetRoleById in roleId int Role UpdateRole in roleid int int DelRoleById in RoleId int int GetRole Role AddRole in roleid int in rolename string int R Ro ol le eS Se er rv vi ic ce e 概要设计说明书编写规范 第 42 页 News News in newid int in title string in body string in sendtime string in username string NewId int Title string Body string SendTime string UserName string N Ne ew ws s GetNewsTitle string GetNewsContent in newid int News AddNew in newid int in title string in body string in sendtime string in username string int DelNewById in newid int int UpdateNewById in newid int int N Ne ew ws sS Se er rv vi ic ce e 概要设计说明书编写规范 第 43 页 Student Student in studentid int in studentname string in sex string in ProfessionId string in Password string StudentId int StudentName string Sex string ProfessionId string Password string S St tu ud de en nt t GetStuById in studentid int Student GetAllStu Student AddStu in stuid int in stuname string in sex string in professionid string in password string int DelStu in stuid int int UpdateStu in stuid int int S St tu ud de en nt tS Se er rv vi ic ce e Teacher Teacher in TeacherId int in TeacherName string in Sex string in ProfessionId string in Password string in Grade string TeacherId int TeacherName string Sex string ProfessionId string Password string Grade string T Te ea ac ch he er r GetTeacherById in teacherid int Teacher GetAllTeachers Teacher AddTeacher in teacher