开拓校园博客系统
项目概要说明书
本文档由XXXX小组撰写,本文档初稿于2009年7月30日完成。本文档由XXXX小组负责解释及执行。 文档描述信息:
文档修订摘要:
目录
1. 引言 ................................................................................................... 5 1.1 编写目的 .................................................................................. 5 1.2 适用范围 .................................................................................. 5 1.3 背景 .......................................................................................... 5 1.4 定义 .......................................................................................... 6 1.5 参考资料 .................................................................................. 6 2. 总体设计 ........................................................................................... 6 2.1 系统概述 .................................................................................. 6 2.2 体系结构 .................................................................................. 7 2.2.1 应用层.............................................................................. 7 2.2.2 业务处理层 ...................................................................... 7 2.2.3 数据连接层 ...................................................................... 8 2.2.4 数据存储层 ...................................................................... 8 2.3 功能模块命名规则 ................................................................... 8 2.4 系统功能模块划分 ................................................................. 12 2.4.1 用户功能模块 ................................................................ 12 2.4.2 系统管理员功能模块 .................................................... 14 2.4.3 匿名用户功能模块 ........................................................ 14 2.5 系统功能设计 ......................................................................... 14 3. 系统出错处理设计。 ...................................................................... 14 3.1 出错信息 ................................................................................ 14
3.2 系统维护设计 ......................................................................... 14 4. 数据库设计 ..................................................................................... 15
1. 引言
1.1
编写目的
本文档旨在描述对菁菁校园博客系统项目的总体概要设计,以便为后续各模块的设计、实现提供依据。本文的预期读者为项目管理人员、项目开发人员、用户。
1.2 适用范围
本文档适用于所有与本项目有关的软件开发阶段的相关人员,其中甲方:客
户代表。乙方:项目经理、技术开发人员(包括分析人员、设计人员、程序人员)。测试人员应重点阅读本文档各部分,其他人员可选择性阅读本文档。
1.3 背景
随着计算机及网络技术的飞速发展,Internet/Intranet应用在
全球范围内日益普及,人们对Internet应用的需求也越来越多,其中网上交友或利用网络和朋友家人联系,在线管理自己的相片等已经成为广大网民的共同需求,在这个背景下,我们的博客系统应需而出。
本项目定位于某一所高校,属于校园内博客系统,由于大学生数量大,同时大学生课余时间多,上网条件和时间充足,大学生交友积极性高,乐于通过网络博客的形式表现自己的学习、情感及生活等特点。本系统以真名方式注册登录,特提供校内博客系统。对学生来说:方便师生之间的课后交流,增进同学之间的友谊,扩大学生的社交范围;深入做到整个学院与师生的互动以及信息的及时。对学院来说:可以集思广益,以舆论的力量监督学院的管理、风气。对学校文化也
起到很好的推动作用,增加在社会的影响力。 1.4
定义
1.5 参考资料
1)《GB/T 12504—90 中华人民共和国国家标准:软件需求分析
规格说明书》。 2)Internet资源。
2. 总体设计
2.1
系统概述
本项目的技术目标是:开拓校园博客系统能够广泛应用于中国各
个高校的内部交流以及资源共享。
2.2 体系结构
本系统采用B/S体系结构,系统分为应用层、业务处理层、数据连接层、数
据存储层等四层。系统的总体体系结构如图所示:
业务处理层
数据连接层
应用层
数据存储层
2.2.1 应用层
应用层Appliction向应用程序提供服务,这些服务按其向应用程序提供的特性分成组,并称为服务元素。有些可为多种应用程序共同使用,有些则为较少的一类应用程序使用。应用层是开放系统的最高层,是直接为应用进程提供服务的。其作用是在实现多个系统应用进程相互通信的同时,完成一系列业务处理所需的服务。其服务元素分为两类:公共应用服务元素CASE和特定应用服务元素SASE。CASE提供最基本的服务,它成为应用层中任何用户和任何服务元素的用户,主要为应用进程通信,分布系统实现提供基本的控制机制。特定服务SASE则要满足一些特定服务,如文卷传送,访问管理,作业传送,银行事务,订单输入等。这些将涉及到虚拟终端,作业传送与操作,文卷传送及访问管理,远程数据库访问,图形核心系统,开放系统互连管理等。
具体功能要求: 使用母版页、CSS样式、Ajax等来实现页面层部分。 2.2.2 业务处理层
业务处理层的作用之一是为异种机通信提供一种公共语言,以便能进行互操作。这种类型的服务之所以需要,是因为不同的计算机体系结构使用的数据表示
法不同。例如,IBM主机使用EBCDIC编码,而大部分PC机使用的是ASCII码。在这种情况下,便需要会话层来完成这种转换。
具体功能要求:封装商业逻辑,提供校验、逻辑实现的功能。 2.2.3 数据连接层
数据连接层Data-Link Layer由于传送数据的网络媒体是以是电子讯号进行传送,所以我们的数据要使用这样的讯号传送时, 就需要制订各种网络型态的讯框 (frame) 了,才能确保数据可以在不同的网络媒体进行传送的动作。
具体功能要求:提供所有与数据库相关的操作。包括:添加更新数据到数据库,从数据库返回数据集。 2.2.4 数据存储层
具体功能要求:数据库主要提供数据存储及查询功能。
2.3 功能模块命名规则
本系统功能模块命名规则如下:
考虑到该文档的阅读对象为客户和相关工作人员,本系统决定采用通俗易懂的名称作为功能模块名。
命名统一采用中文命名,长度控制在六个字内。
系统功能分析是在系统开发总体任务的基础上完成的。本系统的基本功能如表所示:
2.4 系统功能模块划分
2.4.1 用户功能模块 1. 个人管理中心
注册用户可以修改个人的详细资料、可以修改密码、设置访问权限、修改博客标题及简介、修改个人心情。 2. 管理日志
注册用户可以添加、修改、删除日志分类;添加、修改、删除日志;设置日志的访问权限;删除日志评论;回复日志评论;可以保存未发表的日志到草稿箱;可以将自己的日志推荐给管理员或者其他博友。 3. 管理相片
注册用户可以在相册中上传、删除相片、修改相片描述、删除及回复相片的评论。 4. 管理相册
注册用户可以添加、修改、删除相册,设置相册密码。 5. 管理留言
注册用户可以添加、删除、回复留言板的留言,并可以设置留言权限。 6. 管理好友
注册用户可以查找、添加、删除好友,修改好友备注以及好友分类,添加、修改、删除好友分类。 7. 管理收藏
注册用户可以查看、添加、编辑、删除网址,查看、添加、编辑、删除网址分类。 8. 管理模板
注册用户可以根据自己的爱好更换、备份、修改自己博客的模板。 9. 管理应用插件
注册用户可以根据自己的实际需要添加、删除应用插件。 10. 管理消息
注册用户可以查看、删除消息,可以给其他用户或者管理员发送消息,并可以将未发送的消息保存在草稿箱里面。 11. 管理共享资源
注册用户可以上传资料到资源共享模块中,并可以自由删除自己已经上传的资源,可以在资源共享模块中自由下载自己感兴趣的资源。 12. 推荐资源
注册用户可以推荐优秀的日志、相册、相片和模板给所有已注册用户。 13. 举报违规或者非法行为
注册用户可以向普通管理员举报博客中发现的一些非法行为,比如说一些敏感文章和图片等,并可以向高级管理员举报普通管理员在管理中出现的一些违规行为。 14. 站内搜索
注册用户登陆后可以通过一些关键字搜索一些自己感兴趣的内容。 15. 查看最近访客
注册用户登陆后可以在最近访客模块查看最近来访的人员。
2.4.2 系统管理员功能模块 1.高级管理员
高级管理员可以管理用户、管理院系、管理专业、管理班级、发布通知、管理举报中心、管理普通管理员、管理消息、管理系统日志等。 2.普通管理员
普通管理员可以管理模板、管理举报中心、管理消息、审核推荐资源、管理共享资源等。
2.4.3 匿名用户功能模块
匿名用户能访问网站门户的全部内容:包括博客排行、博客推荐、博文排行、博文推荐、相片排行、相片推荐、最新开博、站点活动和新闻、帮助中心、友情链接、人气周榜 、站点统计。如果浏览者要进入不属于网站门户的博客,那么是否可以访问该博客,以及可以对该博客有哪些操作以博主设定的为准。
2.5 系统功能设计
根据不同的功能模块,得到相关功能的流程图及具体操作步骤,详情参看需
求分析说明书。
3. 系统出错处理设计。
3.1
出错信息
系统出现错误时,捕捉到系统的错误,存入错误记录文件中,供相关人员查看。在界面上,不弹出错误页面,以脚本形式给出出错的大概信息提示浏览者。
3.2 系统维护设计
为方便系统的维护,在代码设计中,以对象设计为主、过程设计为辅,每一
个步骤都给出注释,方便维护人员查看代码和阅读代码。
4. 数据库设计
请参考文档《数据库设计》
开拓校园博客系统
项目概要说明书
本文档由XXXX小组撰写,本文档初稿于2009年7月30日完成。本文档由XXXX小组负责解释及执行。 文档描述信息:
文档修订摘要:
目录
1. 引言 ................................................................................................... 5 1.1 编写目的 .................................................................................. 5 1.2 适用范围 .................................................................................. 5 1.3 背景 .......................................................................................... 5 1.4 定义 .......................................................................................... 6 1.5 参考资料 .................................................................................. 6 2. 总体设计 ........................................................................................... 6 2.1 系统概述 .................................................................................. 6 2.2 体系结构 .................................................................................. 7 2.2.1 应用层.............................................................................. 7 2.2.2 业务处理层 ...................................................................... 7 2.2.3 数据连接层 ...................................................................... 8 2.2.4 数据存储层 ...................................................................... 8 2.3 功能模块命名规则 ................................................................... 8 2.4 系统功能模块划分 ................................................................. 12 2.4.1 用户功能模块 ................................................................ 12 2.4.2 系统管理员功能模块 .................................................... 14 2.4.3 匿名用户功能模块 ........................................................ 14 2.5 系统功能设计 ......................................................................... 14 3. 系统出错处理设计。 ...................................................................... 14 3.1 出错信息 ................................................................................ 14
3.2 系统维护设计 ......................................................................... 14 4. 数据库设计 ..................................................................................... 15
1. 引言
1.1
编写目的
本文档旨在描述对菁菁校园博客系统项目的总体概要设计,以便为后续各模块的设计、实现提供依据。本文的预期读者为项目管理人员、项目开发人员、用户。
1.2 适用范围
本文档适用于所有与本项目有关的软件开发阶段的相关人员,其中甲方:客
户代表。乙方:项目经理、技术开发人员(包括分析人员、设计人员、程序人员)。测试人员应重点阅读本文档各部分,其他人员可选择性阅读本文档。
1.3 背景
随着计算机及网络技术的飞速发展,Internet/Intranet应用在
全球范围内日益普及,人们对Internet应用的需求也越来越多,其中网上交友或利用网络和朋友家人联系,在线管理自己的相片等已经成为广大网民的共同需求,在这个背景下,我们的博客系统应需而出。
本项目定位于某一所高校,属于校园内博客系统,由于大学生数量大,同时大学生课余时间多,上网条件和时间充足,大学生交友积极性高,乐于通过网络博客的形式表现自己的学习、情感及生活等特点。本系统以真名方式注册登录,特提供校内博客系统。对学生来说:方便师生之间的课后交流,增进同学之间的友谊,扩大学生的社交范围;深入做到整个学院与师生的互动以及信息的及时。对学院来说:可以集思广益,以舆论的力量监督学院的管理、风气。对学校文化也
起到很好的推动作用,增加在社会的影响力。 1.4
定义
1.5 参考资料
1)《GB/T 12504—90 中华人民共和国国家标准:软件需求分析
规格说明书》。 2)Internet资源。
2. 总体设计
2.1
系统概述
本项目的技术目标是:开拓校园博客系统能够广泛应用于中国各
个高校的内部交流以及资源共享。
2.2 体系结构
本系统采用B/S体系结构,系统分为应用层、业务处理层、数据连接层、数
据存储层等四层。系统的总体体系结构如图所示:
业务处理层
数据连接层
应用层
数据存储层
2.2.1 应用层
应用层Appliction向应用程序提供服务,这些服务按其向应用程序提供的特性分成组,并称为服务元素。有些可为多种应用程序共同使用,有些则为较少的一类应用程序使用。应用层是开放系统的最高层,是直接为应用进程提供服务的。其作用是在实现多个系统应用进程相互通信的同时,完成一系列业务处理所需的服务。其服务元素分为两类:公共应用服务元素CASE和特定应用服务元素SASE。CASE提供最基本的服务,它成为应用层中任何用户和任何服务元素的用户,主要为应用进程通信,分布系统实现提供基本的控制机制。特定服务SASE则要满足一些特定服务,如文卷传送,访问管理,作业传送,银行事务,订单输入等。这些将涉及到虚拟终端,作业传送与操作,文卷传送及访问管理,远程数据库访问,图形核心系统,开放系统互连管理等。
具体功能要求: 使用母版页、CSS样式、Ajax等来实现页面层部分。 2.2.2 业务处理层
业务处理层的作用之一是为异种机通信提供一种公共语言,以便能进行互操作。这种类型的服务之所以需要,是因为不同的计算机体系结构使用的数据表示
法不同。例如,IBM主机使用EBCDIC编码,而大部分PC机使用的是ASCII码。在这种情况下,便需要会话层来完成这种转换。
具体功能要求:封装商业逻辑,提供校验、逻辑实现的功能。 2.2.3 数据连接层
数据连接层Data-Link Layer由于传送数据的网络媒体是以是电子讯号进行传送,所以我们的数据要使用这样的讯号传送时, 就需要制订各种网络型态的讯框 (frame) 了,才能确保数据可以在不同的网络媒体进行传送的动作。
具体功能要求:提供所有与数据库相关的操作。包括:添加更新数据到数据库,从数据库返回数据集。 2.2.4 数据存储层
具体功能要求:数据库主要提供数据存储及查询功能。
2.3 功能模块命名规则
本系统功能模块命名规则如下:
考虑到该文档的阅读对象为客户和相关工作人员,本系统决定采用通俗易懂的名称作为功能模块名。
命名统一采用中文命名,长度控制在六个字内。
系统功能分析是在系统开发总体任务的基础上完成的。本系统的基本功能如表所示:
2.4 系统功能模块划分
2.4.1 用户功能模块 1. 个人管理中心
注册用户可以修改个人的详细资料、可以修改密码、设置访问权限、修改博客标题及简介、修改个人心情。 2. 管理日志
注册用户可以添加、修改、删除日志分类;添加、修改、删除日志;设置日志的访问权限;删除日志评论;回复日志评论;可以保存未发表的日志到草稿箱;可以将自己的日志推荐给管理员或者其他博友。 3. 管理相片
注册用户可以在相册中上传、删除相片、修改相片描述、删除及回复相片的评论。 4. 管理相册
注册用户可以添加、修改、删除相册,设置相册密码。 5. 管理留言
注册用户可以添加、删除、回复留言板的留言,并可以设置留言权限。 6. 管理好友
注册用户可以查找、添加、删除好友,修改好友备注以及好友分类,添加、修改、删除好友分类。 7. 管理收藏
注册用户可以查看、添加、编辑、删除网址,查看、添加、编辑、删除网址分类。 8. 管理模板
注册用户可以根据自己的爱好更换、备份、修改自己博客的模板。 9. 管理应用插件
注册用户可以根据自己的实际需要添加、删除应用插件。 10. 管理消息
注册用户可以查看、删除消息,可以给其他用户或者管理员发送消息,并可以将未发送的消息保存在草稿箱里面。 11. 管理共享资源
注册用户可以上传资料到资源共享模块中,并可以自由删除自己已经上传的资源,可以在资源共享模块中自由下载自己感兴趣的资源。 12. 推荐资源
注册用户可以推荐优秀的日志、相册、相片和模板给所有已注册用户。 13. 举报违规或者非法行为
注册用户可以向普通管理员举报博客中发现的一些非法行为,比如说一些敏感文章和图片等,并可以向高级管理员举报普通管理员在管理中出现的一些违规行为。 14. 站内搜索
注册用户登陆后可以通过一些关键字搜索一些自己感兴趣的内容。 15. 查看最近访客
注册用户登陆后可以在最近访客模块查看最近来访的人员。
2.4.2 系统管理员功能模块 1.高级管理员
高级管理员可以管理用户、管理院系、管理专业、管理班级、发布通知、管理举报中心、管理普通管理员、管理消息、管理系统日志等。 2.普通管理员
普通管理员可以管理模板、管理举报中心、管理消息、审核推荐资源、管理共享资源等。
2.4.3 匿名用户功能模块
匿名用户能访问网站门户的全部内容:包括博客排行、博客推荐、博文排行、博文推荐、相片排行、相片推荐、最新开博、站点活动和新闻、帮助中心、友情链接、人气周榜 、站点统计。如果浏览者要进入不属于网站门户的博客,那么是否可以访问该博客,以及可以对该博客有哪些操作以博主设定的为准。
2.5 系统功能设计
根据不同的功能模块,得到相关功能的流程图及具体操作步骤,详情参看需
求分析说明书。
3. 系统出错处理设计。
3.1
出错信息
系统出现错误时,捕捉到系统的错误,存入错误记录文件中,供相关人员查看。在界面上,不弹出错误页面,以脚本形式给出出错的大概信息提示浏览者。
3.2 系统维护设计
为方便系统的维护,在代码设计中,以对象设计为主、过程设计为辅,每一
个步骤都给出注释,方便维护人员查看代码和阅读代码。
4. 数据库设计
请参考文档《数据库设计》