概要设计文档1.0
吃喝玩乐在武汉概要设计
1. 引言部分
引言部分主要说明编写目的、系统的范围和参考资料等。
1.1目的
该文档的目的是描述“吃喝玩乐在武汉”网页的概要设计,主要内容包括系统功能简介、系统结构设计、模块设计和界面设计等。
本文档的预期读者包括:设计人员,开发人员,项目管理人员,测试人员。
1.2 范围
1.2.1 系统目标
为了方便当地旅游爱好者在网上获取信息,有效地掌握武汉各大旅游景点的详细情况,我们多方听取意见、追加和完善大量实用功能,开发出适合于旅游者在网络上快速获取信息的武汉旅游网页。通过本网页,出行者可以查看某个地区的全部景点列表,了解某个景点的详细情况,自驾车、公交线路,获取景区内的旅游地图及景点门票等。
该网页为游客提供全面的旅游景点查询服务。
1.2.2 主要软件需求
该系统的主要功能包括:
.系统初始化设置
.搜索 景点 美食 地图 酒店
.评论
.景点推送板服务
.个人页面
1.2.3 软件设计约束、限制
软件支持多客户端同时使用的分布式物理结构。
1.3缩写说明
无。
1.4术语定义
暂无。
1.5参考资料
[1]窦万峰.软件工程与实践[M].北京:机械工业出版社,2017.
1.6版本信息
修改编号 |
修改日期 |
修改后版本 |
修改位置 |
修改内容描述 |
1 |
2019-5-10 |
1.0 |
全部 |
完成第一次编写 |
|
|
|
|
|
具体版本信息如表所示。
2. 数据设计
本部分主要描述软件所涉及的外部数据的结构描述。如果数据以数据库文件呈现,则描述表的名称和表字段结构;如果数据以外部文件形式呈现,则要描述文件的内部结构。
2.1数据对象和形成的数据结构
“吃喝玩乐在武汉”网页所设计的主要数据结构如下:
个人页面:用户昵称,用户编码,用户登录日期。
景点推送板:景点名称,美食名称,景点门票,景点星级, 酒店名称,酒店类型,酒店星级,费用,地图,留言评论。
个人信息表:用户编号,用户昵称,用户密码,偏好景点,偏好美食,偏好酒店类型。
用户总表:用户名,用户密码,用户注册用手机号,用户创建日期,用户更新日期。
2.2 文件和数据库结构
描述文件的数据库结构。
2.2.1 外部文件结构
包括文件的逻辑结构、逻辑记录描述、访问方法。
2.2.2全局数据
“吃喝玩乐在武汉”网页的全局变量有:
系统时钟Timer
2.2.3 文件和数据交叉索引
l 用户信息文件在用户管理和用户个人信息(即“我的”)功能中;
l 景点推送板文件用于搜索功能中;
l 社区表文件用于社区功能中;
l 个人信息表文件用于个人信息模块记录搜索偏好功能中。
3.体系结构设计
这一部分主要描述软件的逻辑组成接口,即软件结构图的绘制。
3.1数据和控制流复审
对需求规格说明或产品规格说明中要实现的功能进行归纳分析,对涉及的数据和控制流进行汇总和归并,为概要设计做准备。
一般对数据流图的精化分析包括两个方面的内容,一是审查整个数据流图,查看有没有遗漏的地方,并补充和完善;二是分析每一个数据流图,去掉一些细节的内容,这里去掉了外部用户
3.2得出的总体程序结构
4.界面设计
4.1人机界面规约
(1)登录首界面:该界面能够输入用户名和短信验证码,并且具有用户注册功能;用户名是用户的合法手机号,然后通过获取验证码的方式进行登陆。
(2)景点查询界面:该界面主要是用户输入景点名称进行搜素,最后显示的结果应包括景点介绍,景点附近的美食与酒店,以及通往该景点的路线,并可发表自己的评论或疑惑查看其他游客对该景点的评价。
(3)推送板界面:该界面主要是用户能通过提供的景点信息和百度链接查看热门景点:该界面有多处链接,用户在选择某一链接时能实现跳转功能,方便用户阅读信息。
(4)个人信息界面:该界面主要是能够进行个人信息设置,个人信息包括昵称,头像,注册手机号。
(5)总控界面:是该网站的主界面,主要完成与用户的交互任务,接受用户请求,并调整相应模块。
4.2人机界面设计规约
登陆首界面:
新用户的界面序列:注册----进入总控界面(搜索界面)。
老用户的界面序列:登录----进入总控界面(搜索界面)。
总控界面与景点查询界面序列:总控界面----按景点名称进行搜索----得出搜索结果----选择查看景点介绍----选择发言或浏览评论----刷新界面。
总控界面与推送板界面序列:总控界面----推送板界面----点击链接实现跳转。
总控界面与个人信息界面序列:总控界面----个人信息序列----选择设置个人信息----保存或显示结果。
- 5. 接口设计
本部分主要描述模块的接口类型和参数等
5.1外部接口设计
与外部系统或设备的连接关系和通信方式。
5.1.1外部数据接口
暂无。
5.1.2外部系统或设备接口
与外部的接口仅仅是硬件的接口要求,鼠标与键盘要求是USB接口连接。
5.2内部接口设计规约
内部接口是软件逻辑模块之间的调用接口。
5.2.1内部模块接口调用关系
内部模块的接口调用关系可参看图,为了便于讨论,我们给每一个模块一个编号,并对结构图进一步进行优化。它们的接口调用关系如下。
系统总模块:
登录模块:
注册:
验证身份:
景点查询:
推送板跳转:
个人信息:
5.2.2接口数据结构
待编码后确认
- 6. 模块过程设计
6.1景点查询子系统
(1) 外部用户
用户:系统的合法用户
(2) 功能
通过景点名称查询
(3) 活动图
(4) 场景描述
用例名称:黄鹤楼
范围:武汉
主要参与者:用户
主成功场景:显示黄鹤楼的景点介绍,附近的美食与酒店,前往路线,及可查看其他人的评论或发表评论。
6.2推送板子系统
(1) 外部用户
用户:系统的合法用户
(2) 功能
跳转百度网站
(3) 活动图
(4) 场景描述
用例名称:跳转推荐景点一
范围:推送板子系统
主要参与者:用户
主成功场景:跳转到百度网站
6.3我的子系统
(1) 外部用户
用户:系统的合法用户
(2) 功能
设置个人信息;
修改个人信息.
(3) 活动图
(4) 场景描述
用例名称:修改个人信息
范围:我的子系统
主要参与者:用户
主成功场景:选择设置个人信息,修改昵称,保存。
- 逻辑分析与建模
7.1搜索子系统建模
7.1.2类模型
7.2公告板子系统建模
7.2.2类模板
7.3我的子系统建模
7.3.2类模型
8.需求交叉索引
描述需求与模块的关系,存在交叉部分,即共享模块的调用关系。
l 用户管理:登录,注册
l 搜索:景点类型搜索,附近酒店搜索,附近美食搜索,前往路线查看,查看评论和发表评论。
l 推送板服务:对近期热门景点推送
l 个人页面:设置昵称,查看偏好景区类型。