博客概要设计说明书.docx
《博客概要设计说明书.docx》由会员分享,可在线阅读,更多相关《博客概要设计说明书.docx(18页珍藏版)》请在冰豆网上搜索。
博客概要设计说明书
概要设计说明书
变更记录
日期
版本
变更说明
作者
YYYY-MM-DD
1.0
初始版本
XXX
签字确认
系统模块
对应章节
对应部门
负责人签字
目录
1引言4
1.1编写目的4
1.2背景4
1.3基线4
1.4范围4
1.5定义4
1.6参考资料4
2总体设计4
2.1概述4
2.1.1功能描述4
2.1.2运行环境4
2.1.3开发环境5
2.2设计思想6
2.2.1系统构思6
2.2.2关键技术与算法6
2.3人工处理过程7
3系统功能设计7
3.1系统功能7
4系统数据结构设计7
4.1说明7
4.2数据结构7
4.3数据结构与系统元素的关系7
5接口设计7
5.1用户接口7
5.2外部接口8
6运行设计8
6.1系统初始化8
6.2运行控制8
6.3系统结束8
7系统出错处理设计8
7.1出错信息8
7.2补救措施8
8系统维护设计8
8.1检测点的设计8
8.2检测专用模块的设计9
9尚待解决的问题9
1引言
1.1编写目的
本文档用于描述“博客系统”项目的系统需求,为该项目概要设计,详细设计和测试用例的设计依据。
这个分析的阅读对象为任课老师和小组开发人员。
1.2背景
开发地点:
开发单位:
开发项目名称:
1.3基线
简单一点的Blog记载了日常发生的事情和自己的兴趣爱好,把自己的思想和知识与他人分享、交流,同时又通过个人博客结识更多志同道合的朋友,使大家在网上可以进行各种信息的交流,博客系统为大家提供了学习交流、工作交流、情感交流的平台,使人们的工作更加简单快捷,使人们的生活更加丰富多彩。
本文档用于描述“博客管理系统”项目的系统需求,为该项目概要设计,详细设计和测试用例的设计依据。
该需求规格说明书供概要设计人员阅读。
角色如表1:
表1各角色权限
序号
角色
权限
1
游客
游客无需登陆就可以浏览相册、浏览博文或发表评论
2
博主
登录后就可以修改用户资料,修改密码,发布,修改,删除博文,添加,删除,修改相片,发表评论
3
博客管理员
登陆后就可以管理注册用户,管理系统用户,管理博客文章,管理留言,管理相册
1.4范围
由于时间比较短,使用计算机不方便以及对于网络编程不熟悉,本博客管理系统功能不怎么太全面。
对信息的保护手段仅限于设置用户级别,以及提供数据文件的备份,比较简单,安全性能有待进一步完善。
1.5定义
Blog:
Weblog的简称。
网络日志,通常称为博客。
1.6参考资料
[1]付燕.软件体系结构实用教程.西安电子科技大学出版社.2009,9[2]参考书籍:
软件体系结构原理/实践方法张友生清华大学出版社2006年11月[3]温昱.软件架构设计.电子工业出版社.2007,3
[4]张友生.软件体系结构设计第二版.清华大学出版社.2006,11
2总体设计
2.1概述
2.1.1功能描述
a.注册
【输入数据】
账号、密码
以及各种个人信息,如昵称,生日,住处,爱好等
【输出数据】
注册是否成功的信息
【功能】
系统能够对用户输入的账号、密码等信息进行验证,确定是否可用,然后发送给服务器进行验证,验证通过后则存储于数据库并根据用户提供信息建立个人博客。
如果验证没通过,则提示用户原因。
脚本如图1:
图1注册脚本
b.登陆
【输入数据】
账号、密码
【输出数据】
提示信息
【功能】
系统能够按照用户输入的账号、密码发送给服务器进行验证,验证通过后可根据用户信息进入个人博客主页。
对于验证不通过的账号和密码系统能够做出相应的错误处理。
脚本如图2:
图2登录脚本
c.评论/留言
【输入数据】
所要发表的评论/留言的内容
【输出数据】
发表后内容
【功能】
游客或者注册用户可对当前浏览的博客内容进行评论或对当前浏览的博客进行留言。
评论/留言成功后会在当前博客或内容下显示。
脚本如图3:
图3评论、浏览脚本
d.内容发表
【输入数据】
所要发表的内容的标题,内容与描述
【输出数据】
发表后内容
【功能】
系统能够对用户提交的标题,内容与描述进行验证,验证通过后存储至数据库,然后在当前博客上显示成功提交的内容。
若提交不成功,则显示错误提示信息并返回至内容编辑页面。
脚本如图4:
图4
e.内容管理
1.个人信息管理
【输入数据】
编辑的信息
【输出数据】
提示信息
【功能】
系统能够对用户提交的对个人信息编辑后的内容进行验证,若验证通过,则修改数据库相应信息,然后在页面提示用户编辑成功并显示新的个人信息。
若不通过,则提示错误信息并返回至个人信息页面。
如图5:
图5个人信息管理
2.博客内容管理
【输入数据】
编辑的标题,内容,描述等
【输出数据】
提示信息
【功能】
用户选择需要编辑的博客内容进行编辑,包括修改标题,修改内容,修改描述,修改权限或删除当前内容。
然后系统根据用户提交的信息进行验证,验证成功后修改数据库相应内容,然后提示用户修改成功并显示成功修改后的内容。
若失败,则提示错误信息并返回编辑前内容界面。
如图6:
图6博客内容管理
f.系统管理
1.系统界面管理
【输入数据】
界面所需显示的内容(图片,公告等)
【输出数据】
编辑后界面
【功能】
系统管理员对系统的界面进行管理,如修改界面布局,更改显示图片,发布公告,删除部分内容等。
修改成功后会在用户打开系统时显示修改后的系统界面。
如图7所示:
图7系统界面管理
2.用户博客内容管理
【输入数据】
发送的信息
编辑的内容
【输出数据】
提示信息
发送信息
【功能】
系统管理员对系统的用户博客进行管理。
管理员可以浏览系统用户的博客,对博客内容进行审核,当发现不合规定的内容后,可以对当前内容进行编辑修改或删除,然后发送信息给当前博客用户。
如图8所示:
图8博客内容管理
2.1.2运行环境
a.硬件:
处理器:
Intel486以上系列、AMDK6以上系列
内存:
1G(非最低配置)
网络:
带宽1M(非最低配置)
b.软件:
操作系统:
windows(2000、XP、vista、7、8)
数据库:
SQLServer2008
客户端:
InternetExplore6.0及以上
主流浏览器(firefox,chrome,opera等)
c.运行系统:
windows(2000、XP、vista、7、8)
InternetExplore6.0及以上或主流浏览器(firefox,chrome,opera等)
2.2设计思想
2.2.1系统构思
a.系统目标
本系统主要实现网站建设者与访问者之间的交流,展现网站建设者的思想。
主要实现如下目标:
全面展示博客网站的主题思想
通过发表“我的文章”,表达作者的想法和观点,实现与访问者的相互交流。
通过上传个人相册,使访问者对网站建设者有进一步的了解。
用户可以查看文章,并可以对文章发表意见。
展现最新的的博客列表,方便访问浏览。
提供网站统计信息,使访问者了解网站的基本信息。
对文章信息进行管理。
通过选择文章类别名称添加文正内容,并可以查询、修改和删除文章内容。
对相册信息进行管理。
通过选择相册类别名称上传相册图片信息,并可以查看和删除相册内容。
可以修改管理员登陆信息。
b.系统功能结构
博客网站分为前台和后台。
其中,根据博客前台的特点,可以将其分为博主信息、网络日历、文章查询、公告查询及相册查询等13部分,其中各个部分及其包括的具体功能模块,如图9所示。
根据博客网站后台的特点,可以将其分为用户设置、公告管理、个人相册管理、博客文章管理、投票管理、朋友信息管理及博主信息修改7部分,其中各个部分及其包括的具体功能模块,如图10所示。
图9前台设计
图10后台设计
c.系统流程图
为了更加清晰的表达系统的业务功能模块,下面给出博客网的系统流程图。
对于不同的角色,其所承担的任务也各自不同,流程图也不一样,包括面向用户的客户端流程图和面向系统管理员的的流程图。
如图11所示:
图11系统结构流程图
关键技术与算法
UML技术,mysql数据库技术,JAVAE技术,web技术
2.3人工处理过程
在数据库设计这一快必须要有下列这些人工操作,主要包括如下四点:
1.采集信息
在创建博客数据库之前,必须对博客信息有一个透彻的理解。
与博客网中所涉及的每个人进行交流,以找出他们所作的工作及他们需要从数据库中获得的内容,这是很重要的。
另外,了解该博客系统是否符合实际要求及找出相关系统的问题、限制和屏蔽也很重要。
2.表示对象
在采集信息的过程中,必须标识将由博客数据库管理的主要对象或实体。
对象可以是一个有形的实体(如用户),也可以是一个无形的项目(文章、相册等)。
通常会有几个主要对象,在标识了这些对象之后,相关的项目就会变得清晰。
数据库中每个不同的项目都应有一个对应的表。
3.建立对象实体
标识了博客系统中的对象后,使用该博客系统的一种直观表示方式对这些对象进行记录是很重要的。
在数据库实现期间,可以使用数据库实体作为参考。
4.标识每个对象的信息类型
标识必须为各对象存储的信息类型,这些信息是对象的表中的列(实际上就是数据表字段的类型。
3系统功能设计
3.1系统功能
博客的注册、登录验证功能
普通用户浏览文章和发表评论的管理
文章详细内容及相关评论显示
博客个人文章管理维护功能
博客个人文章分类管理维护功能
博客个人友情链接维护功能
博客个人基本信息管理维护功能
个人上传图片和相册管理的功能
管理员对博主的管理
管理员对个人信息的管理
管理员对网站在线人数的统计
4系统数据结构设计
4.1说明
数据库采用SQLServer数据库。
4.2数据结构
静态数据
(1)用户:
用户ID、用户名称、用户密码、博客主题、说明、E-mail、注册日期、发表日志数。
(2)用户类型表:
用户ID,用户类型。
(2)类别:
类别编号、类别名、类别描述。
(3)日志:
日志编号、日志标题、日志内容、类别编号、发表日期、最后修改日期、用户ID、浏览次数、评论数。
(4)评论:
评论编号、评论标题、评论内容、发表日期、最后回复日期、评论人、日志编号。
(5)留言:
留言编号、留言标题、留言内容、发表日期、最后回复日期、留言人、用户ID。
动态数据
1,注册新用户
2,发表新日志、留言、评论
3,日志、留言、评论的更改
4,个人信息管理
5,管理员更新
4.3数据结构与系统元素的关系
它们是一一对应,相互依赖的。
5接口设计
5.1用户接口
本系统采用图形用户接口,以鼠标和键盘为用户接口,方便用户对博客系统的有效操作。
更好地在博客里进行交流。
5.2外部接口
硬件接口
支持各种x86系列PC机。
5.2.1软件接口
运行于Windows95/98及更高版本具有WIN32API的操作系统之上。
6运行设计
6.1系统初始化
如下表2所示:
表2
输入
处理过程
输出
输入数据类型
账号,密码以及个人信息
注册
提示信息
字符文本,数字
账号,密码
登陆
提示信息,个人博客界面
字符文本,数字
评论/留言内容
评论/留言
提示信息
字符文本
内容主体,标题,描述
内容发表
提示信息,发表后内容
字符文本或图片
编辑的内容
内容管理
提示信息,编辑后内容
字符文本或图片
管理的内容,发送的信息
系统管理
提示信息,编辑后内容
字符文本或图片
6.2运行控制
用户在登录页面后,登录自己的账号密码进行用户登录,而管理员是直接输入管理员账号密码进入管理员页面。
6.3系统结束
用户或管理员操作完毕,退出系统。
7系统出错处理设计
7.1出错信息
用一览表的方式说明每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。
由于输入信息不符合规范(如输入账号密码格式不正确),由于硬件方面的错误(如网络传输超时、硬件出错等)称之为软错误;对于一些关键的操作(如删除操作),应该提供提示确认机制;对于数据文档都是要提供相应的保密措施设置。
7.2补救措施
1.对于软错误,需要在添加/修改操作中及时对输入数据进行验证,分析错误的类型,并且给出相应的错误提示语句,传送到客户端的浏览器上;
2.对于硬错误,错误类型不较少而且比较明确,所以可以在可能出错的地方中输出相应的出错语句,并将程序重置,最后返回输入阶段;
3.后备技术说明准备采用的后备技术,当原始数据丢失时启用的副本的建立和启动的技术,例如周期性的把磁盘信息记录在案;
4.恢复及在启动技术说明将使用的恢复再启动技术,是软件从故障点恢复执行或是软件从头开始重新开始运行的方法。
8系统维护设计
此项主要是对服务器上的数据库以及相关文件进行维护,数据库维护:
我们使用数据库的维护功能机制,比如:
定期备份数据库,定期检测数据库的一致性,定期查看操作日志等;文件方面:
对于下架商品等,定期删除相关文件,减少数据量。
9尚待解决的问题
1.实时更新数据
2.博客推荐(根据博主爱好,进行推荐相关文章)