/frontend

Primary LanguageCSS

MYDG****技术博客平台

​ **——**技术分享博客网站

用户操作手册

2019年 9 月 1 日

目 录

第一章 引言. 1

1.1编写目的. 1

1.2项目背景. 1

1.3定义. 1

1.4参考资料. 1

第二章 软件概述. 2

2.1背景. 2

2.2功能. 2

2.3性能. 3

第三章 运行环境. 3

第四章 使用说明. 3

4.1环境配置. 3

4.2安装和初始化. 3

4.3输入. 3

4.3输出. 4

4.4出错和恢复. 5

4.5求助查询. 5

第五章 运行说明. 5

第六章 非常规过程. 6

第七章 操作命令一览表. 6

第八章 用户操作举例. 7

第一章 引言

1.1编写目的

本说明书作为MYDG个人博客网站项目的用户手册,意在向寻求同其他志同道合的技术人才分享和交流个人技术心得的用户提供MYDG这个便捷、美观且实用的个人技术博客平台。同时也为意愿在相关技术方向进行钻研的读者带来更好的阅读钻研体验。

读者对象:浏览此网站的游客,使用此网站的注册用户和网站管理人员。

1.2项目背景

1.开发网站的名称:MYDG技术博客平台——技术分享博客网站

2.项目的任务提出者:北京航空航天大学大学软件学院软件工程实践

3.开发者:邓坤权 马大慈 余天予 郭婉茹

4.用户:浏览MYDG技术博客平台的游客,MYDG技术博客注册用户,MYDG技术博客网站管理人员

5.实现软件的单位:北京航空航天大学大学软件学院第一题第三小组

1.3定义

1.记录ID:包括“用户”、 “博文”、“评论”、“标签”等项目的唯一标识符;

2.账户:注册用户/管理员在此技术博客分享网站的辨识符。

1.4参考资料

1.《软件工程实用教材》(吕云翔)

2.《计算机软件文档编制规范GB/T8567-----2006》

第二章 软件概述

2.1背景

博客是使用特定的软件,指由个人管理、不定期在网络上出版、发表和张贴个人文章的网站。博客上的文章通常以网页形式出现,并根据张贴时间以倒叙排列。它是继MSN、BBS、ICQ之后出现的第4种网络交流方式,现已受到大家的欢迎,是网络时代的个人“读者文摘”,是以超级链接为入口的网络日记,它代表着新的生活、工作和学习方式。许多博客专注在特定的课题上提供评论或新闻,其他则被作为个人性的日记。一个典型的博客结合了文字、图像、其他博客或网站的链接及其它与主题相关的媒体,能够让读者以互动的方式留下意见,是许多博客的重要要素。博客是社会媒体网络的一部分。

2.2功能

网站实现了用户登录、注册、撰写博文、发表评论、搜索用户、搜索博文、首页最新博文和最热博文的博文推荐、关注用户的功能。

基本页面包括登录页面、注册页面、主页、用户空间、博文浏览页面、博文编辑页面、搜索结果页面和关注列表页面。主页为用户访问网站最先看的页面,向用户展示最新最热博文的推荐条目,和按时间排布的博文列表。

用户空间分为个人博文页面和个人信息页面,个人博文页面包含展示个人博文列表的对应板块,个人信息页面包含可以修改个人信息的板块等。

博文浏览页面展示博文内容、题目、作者信息、博文标签、阅读量和评论数量、评论内容以及评论入口。博文支持本地图片和网络图片的上传浏览。

博文编辑页面包含博文题目,内容的输入区域,其中博文内容部分引用markdown文本编辑器,并且支持本地图片和网络图片。发布前,作者可以为博文添加相关标签,并且包含摘要的输入区域。

搜索结果页面按条目展示搜索结果,搜索选用标题关键字匹配。

注册部分采用邮箱或手机号码注册。

2.3性能

1.能够及时的响应请求信息

2.能够同时处理多个请求信息

3.能够存储大量的数据

4.进行操作请求如:查找、删除、修改、添加时,能够保证输入数据与数据库数据的相匹配性。而在满足请求时,系统能够保证所响应数据的查全率与查准率。

第三章 运行环境

浏览器网页运行

第四章 使用说明

4.1环境配置

进入浏览器使用

4.2安装和初始化

MYDG博客系统是一个网络应用,用户直接连接网址即可进行使用

4.3输入

数据背景

数据来源:用户

存储媒体:华为云主机

出现频率:不限

限制:博客编写查看与检索和个人信息修改

质量管理:如果输入的数据不合理,系统会报错

数据格式

顺序:从左至右输入起点与终点;

搜索分隔符:空格;

省略和重复:无

控制:回车跳转

输入举例

账号:用户账号应不长于十字符;

昵称:用户昵称应不长于十字符;

密码:用户密码应不长于十字符;

4.3输出

数据背景

输出数据的去向:显示给用户;

使用频率:不限;

存放媒体:打印、显示屏;

质量管理:博文标题、简介限制长度输出。

数据格式

输出数据的格式:字段、文章、图片

输出举例

博文标题:显示标题不长于十字符;

4.4出错和恢复

注册

账号、昵称、密码输入格式不合理:需要用户输入合法格式的账号昵称和密码

登录

账号密码输入错误:需要用户输入正确的账号和密码

发表博文

用户没有填写博文内容或题目即发表博文:博文发表其内容或题目不能为空

用户未填写摘要或添加标签:博文发表需要填写博文摘要并选择博文标签

4.5求助查询

访问项目github:

https://github.com/bryantma/newblog.git

第五章 运行说明

表5-1 运行表

功能 操作 运行目的
登录 填写账号/密码 登录网站
注册 填写账号/昵称/密码 注册网站
修改个人信息 修改头像/账号/昵称/密码 修改个人信息
查看博文详情 关注博文作者/编辑自己的博文/评论博文 查看博文
编写博文 编写标题/内容/摘要/标签 编写博文
搜索博文 输入关键字 搜索博文
搜索用户 输入关键字 搜索用户
关注 点击关注/取消关注 关注和取关用户

第六章 非常规过程

操作错误会跳转到404界面,届时用户重新进入网页可恢复之前的操作,后台维护人员会收到报错信息,并及时完善系统。

第七章 操作命令一览表

表7-1 操作命令一览表

操作
注册
登录
退出登录
修改个人信息
查看所有博客
查看热门博客
查看文章归档
查看特定标签的博客
查看自己撰写的博客
搜索标题中带有特定关键字的博客
搜索标题中带有特定关键字的博客
查看博客详情
发表博文
取消发表博文
编辑已发布的博文
关注用户
查看关注用户列表

第八章 用户操作举例

注册:在未登录状态下点击页面顶部的注册按钮,输入合法的用户名、昵称以及密码,点击输入框下的注册按钮即可注册用户。注册后自动登录并跳转至首页。注意注册后的头像为默认头像,若需要更改头像需要通过“修改个人信息”操作进行修改。

登录:在未登录状态下点击页面顶部的登录按钮,正确输入已经成功注册的用户名以及该用户名对应的密码,点击输入框下的登录按钮即可登录。若用户名及密码正确则成功登录,改变用户登录状态为已登录状态并跳转至首页;若用户名未注册或者密码错误则登录失败,网站会进行相应提示。

退出登录:在已登录状态下点击页面顶部的用户头像以及用户昵称区域,在下拉菜单中点击退出即可退出登录状态。

修改个人信息:在已登录状态下点击页面顶部的用户头像以及用户昵称区域,在下拉菜单中点击修改用户信息,跳转至修改个人信息页面。在个人信息修改页面输入框中输入新的昵称、密码,点击页面中部的头像可以选取本地图片更换头像,更新信息输入完毕后点击输入框下的确认按钮即可修改个人信息。

查看所有博客:在首页可以查看本博客网站中所有的博客,博客排序由最新发表决定,越近发表的博客越靠近顶部。

查看热门博客:在首页的右边板块可以查看热门博客,热门博客展示了点击量最靠前的一些博客。

查看文章归档(按月份):首页的右边还有“文章归档板块”,提供按月份查看博客的功能,点击月份进入可以查看该月份发表的所有博客。

查看特定标签的博客:通过顶部栏目中“标签”可以检索所有的标签,点击所需要查看的标签即可查看带有该标签的所有博客。

查看自己撰写的博客:在已登录状态下,通过顶部栏目中的"我的博客"可以查看当前登录用户撰写的所有博客,同样按照时间顺序进行排序。

搜索标题中带有特定关键词的博客:在顶部栏目中的搜索框输入关键词,按下键盘上的回车键,即可检索所有标题中带有该关键词的博客。

查看博文详情:点击所需查看详情的博客的标题即可跳转到博文详情页面查看博文详情。

发表博文:在已登录状态下点击顶部栏目中的“博文编写”可以进入博文撰写页面,合法输入标题以及内容后点击 顶部的“发布”按钮,在弹窗中合法输入摘要并选择文章标签,点击弹窗中蓝色的“发布”按钮即可发布。若是标题、内容、摘要、标签之一的输入不合法,将会得到相应的错误提示,并且在输入合法之前无法进行下一步。需要注意的是,博文的编辑。

取消发表博文:在发表博文的编辑过程中,如果需要取消该博文的发表,可以点击顶部的取消按钮,确认不保存博文后放弃编辑并且返回首页。

编辑已发布的博文:在已登录状态下,查看所需要编辑的博文详情,在该博文的详情页面点击“编辑”按钮即可对已发表博文进行编辑,编辑文章内容过程与确认编辑的方法与发表过程中相对应的过程相同。

关注用户:在已登录状态下,查看所需关注的用户的博文详情页面,点击“关注”按钮即可将该用户添加到关注列表中。

查看关注用户列表:在已登录状态下,点击页面顶部的关注列表即可查看当前登录用户关注的所有用户。

点赞文章:在已登录状态下,进入查看博文详情页面中点击点赞按钮即可为文章点赞。