远程教育系统开发文档.docx
《远程教育系统开发文档.docx》由会员分享，可在线阅读，更多相关《远程教育系统开发文档.docx（39页珍藏版）》请在冰豆网上搜索。
远程教育系统开发文档
第三部分项目
1．项目场景：
远程教育系统
维克远程教育研究中心（VictoryCenterofe-learning，建成维克教育），是一家现代化的远程学习教育机构，总部设在湖南长沙，目前已在武汉、南京、桂林、兰州、沈阳等12个大中城市均设有分支机构。
改组织最近进行了一次大规模的基于网上预定服务的市场调查。
调查结果表明：
大部分专业人士，尤其是年龄在20—到40岁的专业人士，习惯于通过网络进行专业资料的收集和获取，并通过网络进行服务的付费。
于是，VCE准备构建一个在线支持系统来解决这个问题。
CVE的管理层认为，应该通过构建在线支持系统启动两项重要的服务：
信息服务好在线学习。
需要寻求一支技术团队来完成这项工作。
1.1需求描述
1.1.1功能描述
VCE的在线平台需求包括以下主要功能：
1、个人工作台
2、在线课程
3、在线图书馆
4、系统管理
5、在线帮助
1.1.2个人工作台
用户可以在该模块中自定义相关信息，充值等。
1、用户在线注册模块。
用户提供相关信息后可以在线注册到本系统，并成为会员。
2、个性化定制。
用户可以通过该模块修改自己的信息，包括：
电子邮件、地址、电话、QQ、MSN等。
3、充值模块。
用户在该模块中模拟充值的功能。
1.1.3在线课程
向用户提供在线学习资料的课程列表和与之相关的课程说明，用户成为会员后可进行订阅，系统将相关的学习资料通过电子邮件发回给会员，或者可以在线下载。
1、课程查询。
为会员和非会员用户提供课程查询功能，显示课程编号、课程名称、课程描述、课程类别（在线播放课程、课件）、开课时间、费用。
2、邮件通知模块。
为用户提供课程具体相关信息的邮件通知功能。
如：
实际的开课时间，主讲人信息等。
3、课程在线播放模块。
为用户选定的课程提供在线播放能力。
课程应该为视频文件。
收到邮件的用户可以自己通过链接，链入到系统，通过认证后就可以听课。
1.1.4在线图书馆
为系统管理者提供在线书籍和杂志的管理功能，为会员提供在线书籍和杂志查询和在线阅读及现在功能，同时在会员帐户中进行相应的费用扣除。
1、电子图书分类查询。
可以为用户提供作者、工SBN、书名称、出版社的图书查询功能。
2、电子图书借阅。
提供在线阅读功能，费用是一次性扣除。
3、电子书籍和杂志发布和积分管理。
会员可以自由发布自己拥有得电子书籍。
发布的时候要给出电子书籍的名称、文件格式、内容描述以及该电子书籍需要的费用（积分）。
发布电子书籍的用户能够获得相应积分累积，书籍被阅读和下载的次数越多，其积分越高。
开发团队要建立合理的积分模型，同时，建立会员缴费和积分的关系，并根据积分模型运行系统。
1.1.5系统管理
1、在线交易支持管理：
提供一个稳定、高效率的交易管理后台，对于所有收费的模块提供一致的在线交易支持，会员可以通过在线支付升级成为会员。
会员可以通过在线支付进行续费。
对于会员的每一笔消费，应提供电子账单并发送到会员邮箱；对于要求提供纸质账单的用户，应自动打印出一份纸质账单和用户的寄送地址，同时提醒系统管理员在24小时之内将邮件寄出。
2、权限管理：
系统管理员可以增加、维护和删除具有不同权限的角色和属性角色的用户，可以设定信息的发布、查询和维护的权限，可以为没一条信息设置相应的权限。
3、信息管理：
系统管理员可以通过后台管理将各种信息（超文本、office文档、图片、音频、视频等）分类并设置权限后放置到网上。
4、系统管理员可以修改网站的标题、背景图片及页底说明，从而快速建设不同风格的网站。
同时能够根据需要定制新的栏目。
1.1.6在线帮助
为使用该系统的用户提供WEB方式在线帮助文档。
2.项目非功能需求
2.1系统可扩展性
1、当用户的访问量不断增加时，应使系统的整体响应时间依然能够满足用户的需求。
2、具有可扩展的系统框架，当业务扩展时，新的模块或者栏目可以无缝的挂接在系统中。
2.2系统性能要求
系统必须在3.0秒内验证用户请求并做出响应，响应时间最长不得超过10.0秒，除非网络连接中断。
2.3系统安全性要求
1、信息传递必须安全。
2、只有授权用户才能访问信息。
3、在线交易的支付系统平均每月的故障时间不能超过1个小时。
2.4系统易用性要求
用户借助在线系统使用说明，在10分钟以内能够学会如何使用系统进行学习和资料的预定。
2.5用户界面要求
要求为用户提供准确、高效、轻松、愉快的工作界面，充分体现出软件的友好性、易用性；
所有页面都应该被维克教育员工轻松配置；
不论页面是否需要滚动，所有关键服务和功能都应出现在首页上；
主页面应显示网站提供的关键服务的摘要，单击某一项服务应能够打开包括
1、所选服务的详细描述的新页面；
2、应在每一页提供到主页的链接；
3、每一页都应显示“关于我们”和“联系我们”的链接；
4、反馈链接应显示在每一页，方便用户发送匿名反馈；
5、每个页面上都应该显示用户个人资料链接；
6、用户可以根据个人喜好从多种可选的页面风格中选择一种来显示内容，但又不破坏页面显示效果，并且用户的这种选择可以应被储存，以便下次以同样的方式显示。
3.软硬件运行环境
开发工具：
Eclipse3.2+JDT+JDK5.0
中间件服务器：
SpringFramework
持久层：
Hibernate
数据库：
SQLServer2000或者MySQL
操作系统：
windows2000Server
通信协议：
TCP/TP
游览器：
IE6.0以上版本
4．对开发团体的要求
VCE对开发团体的要求是：
1、能根据VCE的业务需求进行分析和建议，提出切实可行的系统解决方案。
解决方案需要说明可以实现的需求点，以及如何以清晰的功能来实现这些需求，还需要说明开发的平台和将要使用的技术，并列出系统的资源要求和配置、部署维护的要求。
2、解决方案必须是模块化的，每个模块应该映射到它支持的需求点，同时定义模块之间的依赖性，详细定义每个模块的安装、配置和相关活动，包括技能、工作量和与之相关的所有依赖性。
3、以增量的方式进行快速开发，首先完成试用版本，实现基本的功能。
开发者应提供项目实施方法和项目工期计划、测试验收计划。
4、能从应用的角度出发，对在线系统需求进行优化，实现在线系统的价值最大化。
5．开发文档
5.1项目可行性分析报告
1、市场分析
提示：
1）分析市场发展历史与发展趋势。
说明本产品处于市场的什么发展阶段。
2）本产品和同类产品的价格分析。
3）统计当前市场的总额．竞争对手所占的份额，分析本产品能占多少份额。
4）产品消费群体特征．消费方式以及影响市场的因素分析。
注意：
引用数据应当写明数据来源，最好有直观的图表。
2、政策分析
提示：
1）分析有无政策“支持”或者“限制”。
2）分析有无地方政府（或其它机构）的“扶持”或者“干扰”。
3、技术和时间分析
提示：
1）从技术角度分析本产品“做得了吗？
”．“做得好吗？
”。
2）按照正常的运作方式，开发本产品并投入市场还来得及吗？
3）预算中的人员能及时到位吗？
4）预算中的软件硬件能及时到位吗？
4、成本-效益分析
提示：
1）估计总本
2）估计总收益
5、SWOT分析
提示：
1）我们的强项是什么？
我们如何利用这些强项？
2）我们的弱项是什么？
我们如何减少这些弱项的影响？
3）市场为我们提供什么样的机会？
我们如何把握这些机会？
4）什么威胁着我们的成功？
我们如何有效地对付这些威胁？
6．知识产权分析
提示：
1）分析是否已经存在某些专利将妨碍本产品的开发与推广；
2）分析本产品能否得到知识产权保护，如何获得？
5.2项目估算表
项目估算表
1.项目范围估算
功能点（功能需求）
关键问题和复杂性描述
实现远程系统
如何开发代码和其余问题
2.开发工作量．人员．进度估算
过程域
工作量
人力资源，起止日期
需求开发
比较大
普通，5月-6月
软件设计
难度较大
普通，5月-6月
软件实现
难
普通，5月-6月
系统测试
普通
普通，5月-6月
验收与发布
简单
普通，5月-6月
3.设备资源估算
设备名称
配置说明
用途
计算机
一般配置
编写代码和文档
项目开发
书和网上资料
无
4.项目经费估算
费用类型
无
用途
人员工资
无
项目开发人员的雇佣工资
办公租金
无
项目开发的软件．硬件资源
项目经理签字
无
机构领导审批意见
无
5.3项目任务书
项目的任务进度计划
任务名称
工作人员
工作时间
任务描述
概要需求分析
唐建，李卓樯，明川
5.26—5.26
项目分配和概论讨论
唐建，李卓樯
需求分析
详细需求设计
唐建，李卓樯
唐建，明川
李卓樯，明川
唐建，李卓樯
唐建，明川
李卓樯，明川
唐建，李卓樯
唐建，李卓樯
唐建，李卓樯
唐建，李卓樯、明川
5月到6月
创建用例图、编写用例文档、编写测试用例
屏幕初步设计
数据库设计
页面设计、类图设计
技术讨论
Java代码
测试网站
编写和错误报告
未解决的问题
5.4项目进展报告
项目测试报告
项目名称
远程教育系统
测试人员
唐建，李卓樯，明川
报告名称
第一周项目进展报告
项目所处阶段
5月—6月
时间段
考试前
工作总结
完成了项目分配和概念讨论并进行了概要需求分析及初步的详细设计
问题及策略
暂时无
5.5项目风险报告
项目的风险表格
风险编号
严重性
可能性
风险描述
解决措施
结果
001
严重
少
场地出毛病
速度修理
风险规避
002
严重
少
项目改变
应该不会
风险规避
003
严重
少
人员离职
绝对不会
风险规避
004
一般
少
人员减少
照样
风险规避
…….
5.6项目变更控制报告
问题:
无
5.7个人变更记录
问题：
无
5.8配置管理计划
配置管理计划
项目名称
远程教育系统
配置管理软件
Eclipse
文档管理计划
负责人
完成时间
明川
5月—6月
代码库的目录结构
主要代码和库
完成时间、负责人
数据库
唐建5月—6月
Java代码
李卓樯5月—6月
备份
已经备份
意见
无
5.9用户界面检查表
用户界面检查表
设计要素
重要性
检查项
适用于
检查结果
合适性
非常重要
用户界面是否与软件的功能相融洽：
用户界面是否合用于用户的引用环境？
解释：
如果否定的话，意味着用户不能有效地使用这个软件，是不可原谅的缺陷。
这个缺陷是需求分析错误造成的。
评审
测试
一般
容易理解
非常重要
（1）界面元素有错别字，或者措词含糊、逻辑混乱。
（2）消息框的提示文字和按钮在语义上不连贯。
（3）确认消息框、警告消息框、通知消息框、过程消息框的风格混淆在一起。
解释：
如果出现如痴低级的缺陷，说明开发人员根本没有把用户界面放在心上，用户很反感这种不敬业的态度。
是不可原谅的缺陷。
评审
测试
故障较少
重要
（1）对于常用的功能，用户能否不必阅读手册就能使用吗？
（2）是否所有界面元素提供了充分而必要的提示？
（3）界面结构和工作流程匹配吗？
（4）提供联机帮助吗？
解释：
如果实现上述要求，说明界面的细节做的很好。
评审
测试
一般
及时反馈信息
重要
（1）是否提供进度条、动画等反映正在进行的比较耗时间的过程？
（2）是否为重要的操作返回必要的结果信息？
解释：
如果否定的话，说明用户界面不够专业。
测试
良好
防错处理
非常重要
（1）执行破坏的操作之前，是否过的用户的确认？
（2）输入数据或者递交数据时，是否进行相应的数据效验（检查数据是否合法）
（3）是否根据用户的权限自动隐藏或者禁用某些功能？
解释：
如果否定的话，说明开发人员没有放错处理的常识，是不可原谅的缺陷。
测试
良好
可选
是否提供Undo功能用以撤销不期望的操作？
解释：
如果实现该要求，说明界面的细节做得很好
测试
良好
一致性
重要
（1）同类的界面元素是否有相同的视感和相同的操作方式？
（2）是否符合广大用户适用同类软件的习惯？
解释：
如果否定的话，说明用户界面不够专业。
评审
测试
个性化
可选
是否在具备必要的“一致性”的前提条件下，设计了与众不同的、让用户记忆深刻的界面？
解释：
如果实现该要求，说明界面很有创意。
评审
测试
良好
合理布局
可选
（1）界面的布局符合软件的功能逻辑吗？
（2）界面元素是否在水平或者垂直方向对齐？
（3）界面元素的尺寸是否合理？
行、列的兼具是否保持一致？
（4）是否恰当地利用窗体和空间的空白，以及分割线条？
（5）窗口切换、移动、改变大小时，界面正常吗？
解释：
如果否定的话，说明用户界面细节很好。
评审
测试
良好
合理色彩
重要
（1）界面的色调是否让人感到和谐、满意？
（2）重要对象是否用醒目的色彩表示？
（3）色彩使用是否符合行业的习惯？
（4）是否可以让色盲、色弱人员使用？
解释：
如果实现该要求，说明界面细节很好。
评审
测试
良好
适应用户群体
可选
（1）初学者和专家都有合适的方式操作这个界面吗？
（2）色盲或者色弱的用户能正常使用该界面吗？
解释：
如果实现该要求，说明界面细节很好。
测试
良好
国际化
重要
（1）度量单位、日期格式、人的名字等是否让用户误解
（2）翻译文字是否地道，是否符合读者习惯？
评审
测试
良好
最小步骤最高效率
重要
是否合理的最小步骤实现常用的操作，获得高效率？
解释：
如果实现该要求，说明界面细节很好。
测试
良好
可复用
重要
用户界面的原型、代码、文档是否可以被复用？
解释：
如果实现该要求，说明软件的需求分析设计、实现做得很好。
开发团队内部评估
良好
5.10软件总体设计文档
1.1文档介绍
1.2文档目的与范围
1.3读者对象
1.4参考文献
提示：
列出本文档的所有参考文献（可以是非正式出版物）,格式如下：
[标识符]作者，文献名称，出版单位（或归属单位），日期
1.5属于与缩写解释
缩写、术语
解释
无
无
无
无
无
无
……
2.系统概述
提示：
（1）说明本系统“是什么”；
（2）描述本系统的主要功能。
3.设计约束
提示：
（1）需求约束。
体系结构设计人员从需求文档（如《用户需求说明书》和《软件需求规格说明书》）中提取需求约束，例如：
²本系统应当遵循的标准或规范
²软件、硬件环境（包括运行环境和开发环境）的约束
²接口/协议的约束
²用户界面的约束
²软件质量的约束。
如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。
（2）隐含约束。
有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，设计人员应当尽可能地在此处说明。
例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖。
3.开发与运行环境
提示：
说明本系统应当在什么样的环境下开发和应用，有什么强制要求和建议？
类别
标准配置
最低配置
开发环境
WindowsXP操作系统
Windows98操作系统
Weblogic8.1
Weblogic8.1
MyEclipse4.1.1
MyEclipse4.1.1
测试环境
WindowsXP操作系统
Windows98操作系统
Weblogic8.1
Weblogic8.1
MyEclipse4.1.1
MyEclipse4.1.1
运行环境
WindowsXP操作系统
Windows98操作系统
Weblogic8.1
Weblogic8.1
MyEclipse4.1.1
MyEclipse4.1.1
4.软件的总体结构图
提示：
（1）将系统分解为若干子系统，绘制各种结构图（例如层次结构图、数据流图），说明各子系统的主要功能。
（尽可能简单明了，但是能够阐述清楚系统的结构）。
（2）说明“如同”以及“为什么”（howandwhy）如此分解系统。
（3）说明各子系统如何协调工作，从而实现原系统的功能。
4.1结构图A
4.2结构图B
无
5.功能模块设计概述
5.1模块命名规则
提示：
说明源文件、类、函数、变量等命名规则
5.2模块汇总
子系统A
模块名称
设计概念
登陆
完成会员的正常登陆
注册
普通用户的注册功能
……
子系统B
模块名称
设计概念
个人工作台
满足个人有一个小的环境
在线图书馆
使得用户在线能进入图书馆并且观看书籍
……
6.数据库设计概述
6.1数据库环境说明
提示：
说明所采用的数据库系统，设计根据，编程工具，有关配置等
6.2数据库命名规则
提示：
说明表、字段等命名规则
6.3安全性设计说明
提示：
考虑用户、访问权限等
6.4表汇总
表名
设计概述
表A
在Office2003上编写
表B
文档中编写
表C
无
7.用户界面设计概述
提示：
说明界面设计要素，注意事项，界面原型等。
8.综合考虑
8.1稳定性和扩展性
提示：
在“软件”生命周期内，判断哪些需求是不变的，预测哪些需求可能发生的变化。
在总体设计的时候，既要使总体结构稳定，又要适应需求变化。
8.2性能分析
提示：
（1）本系统应当具备哪些性能指标才能满足用户需求？
（2）如何实现性能指标？
8.3复用和移植
提示：
（1）本系统复用了什么东西（说明出处）？
如何解决被复用成果的质量问题？
（2）本系统中哪些东西使可以被将来的系统复用的？
有什么意思？
（3）如何使本系统的功能代码和用户界面代码区分开来？
8.4防错与出错处理
提示：
（1）如何预防系统出错？
（2）如果系统出错了，如何处理减少危害？
8.5其它（无）
5.11软件体系结构设计
0.文档介绍
0.1文档目的与范围
0.2读者对象
0.3参考文献
提示：
列出本文档的所有参考文献（可以是非正式出版物），格式如下：
[标识符]作者，文献名称，出版单位（或归属单位），日期
0.4术语与缩写解释
1.系统综述
提示：
（1）描述系统及其目标
（2）系统的边界定义
2．需求
提示：
（1）引导分离的需求文档
（2）和体系结构相关的3类需求
功能需求（用例图）
质量属性需求（性能，可用性）
设计约束（例如，系统应该使用Hibernate完成持久性）
3.试图
3.1系统整体用例图
提示：
（1）一般是一个大强
展示出元素及其关系
应该有明确的图示及说明
对每个符号，包括“连线”给予说明
3.2用例描述
提示：
（1）文字或者表的形式解释系统整体用例图中的元素
（2）例如
用户名称
注册
主执行者
用户
前置条件
普通用户访问本网站首页，点击“注册”
后置条件
用户注册为会员，进入登陆后的网站界面。
涉众利益
用户希望注册步骤简单易操作。
基本路径
1.系统显示用户需要填入的注册信息
2.用户输入注册信息。
3.系统检查输入的信息。
4.注册信息合法，系统进入会员登陆后界面，提示用户注册成功。
扩展
用户输入的注册信息非法时；
1.系统提示用户输入非法，需要新输入。
2.返回。
字段列表
会员账号、会员密码、确认密码、昵称、真实姓名、性别、联系电话、联系地址、Email、（QQ、MSN）两者必添一项、验证码。
设计规划
注册的用户名是唯一的；命名规则待定。
未解决问题
多
！
用例名称
查看个人信息
主执行者
登陆会员
前置条件
会员登陆系统
后置条件
会员查看到自己账号的基本新机和消费记录
涉及利益
会员更加容易查看到自己的信息
基本路径
1.登陆后点击个人工作台
2.进入个人信息平台
3.在个人平台的默认页面会看到个人的基本信息
4.用户可以点击左边个人导航条的查看消费记录
扩展
1．用户悬着查看课程消费
2．用户选择查看图书消费
3．用户选择查看服务消费
字段列表
1．基本信息包括：
会员账号、昵称、真是姓名、性别、联系电话、联系地址、Email、QQ、MSN、余额、积分、会员服务。
2．课程消费包括：
课程名、时间、费用。
3．图书消费包括：
图书名、时间、下载费用、查看费用。
4．服务消费包括：
服务名、时间、费用。
未解决问题
用例名称
积分兑换
主执行者
登陆会员
前置条件
会员登陆系统
后置条件
会员通过积分兑换余额
涉众利益
会员可以利用积分消费
基本路径
1．登陆后点击个人工作台
2．进入个人信息平台，点击积分兑换
3．兑换的积分数
4．提交兑换
扩展
不变
字段列表
无
设计规约
100积分换1点余额
未解决问题
多
3.3可选项指导
提示：
（1）明确说明系统可被配置的点
（2）池中的实例数量
（3）可选择组件（插件）
（4）组件和连接器的不同实现
（5）在构建、部署和运行时可被参数化的值
3.4体系结构背景
提示：
（1）设计决策的原则（包括说明被拒绝的候选方案）
（2）分析、原型和试验的结果
（3）影响试图假设和约束
3.5相关的视图
提示：
（1）指向父视图或者子视图
4.视图间的映射
提示：
（1）用表的形式说明不同视图件元素间的映射
（2）例如：
ElementinRuntimeViewX
ElementinModuleViewY
BankAdmin
Com.sun.ebank.appclient
Com.sun.ebank.util
Stubsfromcom.sun.ebank.ejb
Webbrowser
—
WebUI
Web
Com.sun.ebank.util
Stubsfromcom.sun.eban.ejb
AccuntControllerEJB
Com.sun.ebank.ejb
Com.sun.ebank.util
AccountEJB
Com.sun.ebank.ejb
Com.sun.ebank.util
……
……
5.体系结构分析和原则
提示：
（1）视图设计决策的原则（包括被拒绝的候选项）
（2）软件体系结构评估的结果（例如：
ATAM报告）
6．需要到体系结构的映射
提示：
（1）说明软件体系结构中的组件和方法时如何来满足每一个需求的。
5.12数据库设计文档
0．文档介绍
0.1．文档目的与范围
0.2．读者对象
0.
升级会员 