在线教育网站概要设计说明书_v1.0.doc

XXX 概要设计说明书概要设计说明书 南京航空航天大学 计算机科学与技术学院第 1 页 共 14 页 编写 曾妍庆日期 2015 05 09 审核 日期 批准 日期 受控状态 是 发布版次 1 0日期 2015 05 09 编号 SSOES201505091 0 在线教育网站概要设计说明书在线教育网站概要设计说明书 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 2 页 共 14 页 变更记录变更记录 日期版本变更说明作者 2015 05 091 0初始版本曾妍庆 签字确认签字确认 系统模块对应章节对应部门负责人签字 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 3 页 共 14 页 目目 录录 1引言引言 5 1 1编写目的 5 1 2背景 5 1 3基线 5 1 4范围 5 1 5定义 5 1 6参考资料 5 2总体设计总体设计 5 2 1概述 5 2 1 1功能描述 5 2 1 2运行环境 6 2 1 3开发环境 6 2 2设计思想 7 2 2 1系统构思 7 2 2 2关键技术与算法 8 2 2 3关键数据结构 9 2 3人工处理过程 9 3系统功能设计系统功能设计 9 3 1个人办公 9 3 1 1日程安排 9 4系统数据结构设计系统数据结构设计 14 4 1说明 14 4 2数据结构 14 4 3数据结构与系统元素的关系 14 5接口设计接口设计 14 5 1用户接口 14 5 2外部接口 14 6运行设计运行设计 15 6 1系统初始化 15 6 2运行控制 15 6 3系统结束 15 7系统出错处理设计系统出错处理设计 15 7 1出错信息 15 7 2补救措施 15 8系统维护设计系统维护设计 16 8 1检测点的设计 16 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 4 页 共 14 页 8 2检测专用模块的设计 16 9尚待解决的问题尚待解决的问题 16 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 5 页 共 14 页 1 引言引言 1 1 编写目的编写目的 本说明书目的在于明确说明在线教育网站各功能的实现方式 指导开发员进行编码 编写本说明书的目的是 1 为编码人员提供依据 2 为修改 维护提供条件 3 项目负责人将按计划书的要求布置和控制开发工作全过程 4 项目质量保证组将按此计划书做阶段性和总结性的质量验证和确认 本说明书的预期读者包括 1 项目开发人员 特别是编码人员 2 软件维护人员 3 技术管理人员 4 执行软件质量保证计划的专门人员 5 参与本项目开发进程各阶段验证 确认以及负责为最后项目验收 鉴定提供相应 报告的有关人员 6 合作各方有关部门的负责人 7 项目组负责人和全体参加人员 Little Stars 胡文星 李江川 梁浩 邓嘉兴 盛 炅晗 黄宏镛 陈海燕 曾妍庆 1 2 背景背景 待开发软件系统的名称 SSOE Super Star Online Education System 此软件系统任务提出者 WillJean 王健 此软件系统任务开发者 Little Stars 小组名 此软件系统任务用户 互联网用户 1 3 基线基线 在线教育网站需求分析说明书 v1 0 1 4 范围范围 资源 配置 时间 人力 资源 配置 时间 人力 时间 一个月 人才 Little Stars 八人 共 40 个页面 5 个页面 人 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 6 页 共 14 页 1 5 定义定义 SSOES Super Star Online Education System 在线教育网站 SS 出品 Little Stars 小星星组合 总体设计 对有关系统全局问题的设计 也就是设计系统总的处理方案 又称系统概 要设计 它包括 计算机配置设计 系统模块结构设计 数据库和文件设计 代码设 计以及系统可靠性与内部控制设计等内容 运行设计 是针对建筑或环境的特定要求 以活动发生地点的建筑或场地设计及现状 条件为基础 对活动运行期间的空间分配 人行和车辆流线及运行所需的临时设施进 行的妥善安排和布置 MySQL5 0 MySQL 名字的来历 MySQL 是一个小型关系型数据库管理系统 开发者 为瑞典 MySQLAB 公司 在 2008 年 1 月 16 号被 Sun 公司收购 MySQL 被广泛地应 用在 Internet 上的中小型网站中 由于其体积小 速度快 总体拥有成本低 尤其是 开放源码这一特点 许多中小型网站为了降低网站总体拥有成本而选择了 MySQL 作 为网站数据库 其中 5 0 是其一个版本号 1 6 参考资料参考资料 属于本项目的其他已发表的文件 本文件中引用的其他文献 资料以及软件开发标准 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 7 页 共 14 页 2 总体设计总体设计 2 1 概述概述 2 1 1功能描述功能描述 2 1 2运行环境运行环境 Windows Linux 等系统下的浏览器环境 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 8 页 共 14 页 2 1 2 12 1 2 1软件环境软件环境 分类名称版本语种 操作系统Windows皆可中文 操作系统的附加功能ftp 服务器 JDK 等 数据库平台MySQL 数据库平台补丁 应用平台 应用平台补丁 邮件系统163 QQ 邮箱 客户端软件无 2 1 2 22 1 2 2硬件环境硬件环境 服务器最低配置推荐配置 CPU Inter Pentium E 2200 或 AMD Athlon 5000 及以上 内存 512M 以上 硬盘 8G 以上 应用和数 据库服务 器 网卡 10M 1000M Ethernet邮件服务 器 2 1 3开发环境开发环境 2 1 3 12 1 3 1服务器软件环境服务器软件环境 分类名称版本语种 操作系统Windows 操作系统的附加功能ftp 服务器 JDK 等 数据库平台MySQL 数据库平台补丁 应用平台WEB 服务器软件 IIS6 0 应用平台补丁 版本控制系统CDS XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 9 页 共 14 页 目录服务系统 邮件系统163 QQ 邮箱 客户端软件无 2 1 3 22 1 3 2服务器硬件环境服务器硬件环境 服务器最低配置推荐配置 双核 CPU 内存 2G 以上 硬盘 80G应用服务 器 数据 库服务器 邮件服务 器 目录 服务器 2 1 3 32 1 3 3开发机器软件环境开发机器软件环境 分类名称版本语种 操作系统Windows NT Server 2003 或更高版本 操作系统的附加功能浏览器 IE 6 0 以上 数据库平台MySQL 应用平台 开发平台 客户端软件无 2 1 3 42 1 3 4开发机器硬件环境开发机器硬件环境 分类最低配置推荐配置 Pentium III 处理器 最低 64 MB 内存 最小 2 1 GB 硬盘 开发机器 鼠标 键盘 100M 以太网卡 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 10 页 共 14 页 2 2 设计思想设计思想 2 2 1系统构思系统构思 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 11 页 共 14 页 2 2 2关键技术与算法关键技术与算法 SpringMVCSpringMVC 与与 HiborrateHiborrate MybatisMybatis 2 2 3关键数据结构关键数据结构 2 2 3 1XXXXXX 简要说明本系统中的最主要的数据结构 2 3 人工处理过程人工处理过程 说明在本系统的运行过程中不得不包含的人工处理过程 若有的话 指出该处理过程在系 统中的前后相关的功能及操作 该过程出现的原因 输入 输出 处理过程 教育网站注册登陆需要会员人工输入账号密码 后台视频的审核 涉及到版权问题以及视频内容是否适合教育的问题 3 系统功能设计系统功能设计 此部分主要对关键功能进行设计 描述其实现方式 如果对详细设计要求不高 也可在下面的部分中包括对详细设计的功能说明 不必另建详 细设计文件 此部分主要对各模块功能进行分解 尽量能细化到每一个操作 同时附以特 征界面和数据表设计 3 1 在线教育网站功能在线教育网站功能 3 1 1 首页首页 首页包含视频商城 图书商城 在线模考 面授报班 会员增值 会员中心六大模块 在首页能满足登陆注册 以及首页中各个功能的跳转 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 12 页 共 14 页 将参照这种模式 走简约风 4 系统数据结构设计系统数据结构设计 4 1 说明说明 在面向对象的设计方法中 数据也可以作为一个对象来处理 如果数据附属于某一对象 可以将其纳入该对象的属性管理之中 所以在面向对象的设计过程中 对数据的设计是在 对对象的设计过程中完成的 4 2 数据结构数据结构 列出本系统使用的主要数据结构 包括它们的名称 标识符及数据项等 在线教育网站系统 在 mysql 上是一个物理数据库 命名为 GRUSystem 系统的物理结 构具体有数据库来设计与生成 目前网站正在起步阶段中 并没有完全的数据结构展示 4 3 数据结构与系统元素的关系数据结构与系统元素的关系 说明各个数据结构与访问这些数据结构的各个系统元素之间的对应关系 将数据和系统的 程序模块有机地结合起来 可以进一步向系统最终的数学模型 程序语言 靠近 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 13 页 共 14 页 5 接口设计接口设计 5 1 用户界面设计规则用户界面设计规则 1 尽量保持一致性 界面规范应遵循 MS Windows 软件界面的规范 2 设计完整的对话过程 系统的每一次对话都应该有明确的次序 开始 中间处理 过程 结束 3 提供简单的错误处理机制 4 提供信息反馈 用多种信息提示用户当前软件运行状态 5 2 内部接口设计内部接口设计 5 21 前台管理接口 由系统用户选择不同的菜单调用不同模块 然后在该模块中顺序调用各个子模块 对各种 客户的要求进行不同操作 发出接待信息或驳回预订 5 22 用户管理接口 根据系统用户命令选择调用关于系统用户的各种设置 例如删除 添加 查询 6 运行设计运行设计 6 1 系统初始化系统初始化 说明本系统的初始化过程 以流程的方式描述系统依次的动作 包括内存使用情况 数据 初始化 对象的初始化等 6 2 运行控制运行控制 a 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合 说明每种运 行所历经的内部模块和支持软件 b 说明每一种外界运行控制的方式方法和操作步骤 c 说明每种运行模块组合将占用各种资源的情况 d 说明系统运行时的安全控制 6 3 系统结束系统结束 说明本系统的结束过程 以流程的方式描述系统退出时依次的动作 包括内存释放情况 对象的释放等 XXX 概要设计说明书概要设计说明书内部文档 南京航空航天大学 计算机科学与技术学院第 14 页 共 14 页 一般情况下系统出错设计和系统维护设计不应简化 但对特定情况下 如用户需求中未明 确规定或项目周期较短 经费较少 项目复杂程度较少等 这两部分的设计可以简化 7 系统出错处理设计系统出错处理设计 7 1 出错信息出错信息 在用户访问没有权限的数据后 系统给出提示 对不起 你非法使用数据 没有权限 而且学用户的密码管理可以允许用户修改自己的密码 不允许用户的匿名登录 7 2 补救措施补救措施 说明故障出现后可能采取的变通措施 包括 a 后备技术 当原