用户手册编写提示

用 户 手 册

H.1 引言

H.1.1  编写目的

       为了帮助用户更好地了解和使用该软件，提高用户与软件的亲和度。用户手册讲述怎样配置和使用该小程序，以及该软件使用过程中应注意的一些问题。

H.1.2 背景

说明：

a、这份用户手册所描述的软件系统的名称：电子科大校园地图UESTC Campus Map

b、该软件项目的任务提出者：学生金成哲，陆冠臣，罗子建

c、该软件的开发者用户:金成哲，陆冠臣，罗子建

d、该软件额的用户（或首批用户）：在校学生，教师，校园游客

e、安装此软件的计算中心:微信

 

H.1.3  定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

 

H.1.4  参考资料

《玩转django2.0》——黄永翔  清华大学出版社 2018-11

《从零开始学微信小程序开发》——高洪涛 电子工业出版社 2018-2

《微信小程序快速开发》——易伟 人民邮电出版社 2017-5

H.2用途

H.2.1  功能

       a.游客与学生身份的登陆认证管理：可对普通游客身份和学生身份进行认证，并对认证成功的学生身份提供论坛功能。

       登陆界面如下：

 

 

     b.提供地图模块：根据校园地图的实际情况和论坛现状提供对应服务

     （2）清水河校区主界面如下：

 

     （3）沙河校区主界面如下:

                                 

c. 地点的介绍模块：对已标记的地点提供功能介绍

    （4） 介绍界面如下：

 

d. 地点的论坛讨论模块：针对该地点的校内论坛讨论

     （5） 讨论界面如下：

 

e. 个人用户界面：登陆，历史关注等功能

        （6）用户界面如下：             

        （7）历史关注界面如下：

 

f. 发布模块：针对不同地点，发布功能介绍以及讨论内容。

   （8）发布功能介绍界面如下：

 

   （9）发布讨论内容界面如下：

 

H.2.2  性能

H.2.2.1  精度

       针对校园地图的经纬度，该软件可达到小数点后六位

H.2.2.2  时间特性

响应时间：迅速

更新处理时间：根据用户反应情况而定

数据传输：迅速

转换时间：迅速

计算时间：迅速

 

H.2.2.3  灵活性

1. 用户操作方式：用户可以选择任意编辑键盘和输入法，也可以直接在列表框中选择输入信息，比如：标签点，身份，上传图片。
2. 运行环境：只要手机含微信客户端都可以运行
3. 结果精度：校园地图的经纬度可达到小数点后六位。
4. 时间特性：运行环境的改变不影响该软件的响应时间以及数据传输效率

H.2.2.3  安全保密

a．用户之间不能相互修改密码，即各用户只有自己登录系统才能修改自己的登录密码；各人员的密码皆不可见。用户id及登陆密码采用md5加密传输，极小概率出现泄露问题。

b．各用户只能在自己的权限范围内操作，无法实现超越自己权限的任何操作，实现了数据的安全和保密。

c. 各用户发布的功能介绍，讨论，评论和图片映射关系符合数据库设计的第三范式。安全系数和保障较高。

H.3 运行环境

H.3.1  硬设备

       智能手机皆兼容

       操作系统 ios, Android手机系统兼容

H.3.2  支持软件

操作系统 ios, Android手机系统兼容

   数据库管理系统：Mysql 5.7

   支持软件：微信

H.3.3  数据结构

       数据库名称：weixinxiaochengxu

H.4 使用过程

H.4.1  安装与初始化

       在微信用户界面点开该小程序即可运行。

       登陆界面：只需点击“同意”,允许小程序加载用户头像和用户id。

H.4.2  输入

H.4.2.1  输入数据的现实背景

说明输入数据的现实背景，主要是：

a、情况──发布的功能介绍，讨论，评论，图片的更新，地图功能的查询

b、情况出现的频度──随机的

c、情况来源──学生及游客

d、输入媒体──手机

e、限制──必须要有登入密码和相应的权限访问特定数据。

f、质量管理──要求输入数字而不小心输入字符时会提示错误，并重新输入。

                        图片格式不对，会提醒错误，重新输入。

g、支配──根据数据表的设计原则判断输入数据是否保留还是废弃

 

H.4.2.2  输入格式

 

表名	属性	类型	精度	长度
标记点表	标记点id	整数		20
	标记点名	字符串		20
	经度	浮点类型	6	9
	纬度	浮点类型	6	9
	地点描述	字符串		20
用户表	用户id	整数		20
	用户头像URL	URL
	用户昵称	字符串		20
	用户哈希名	字符串		20
功能表	功能id	整数		20
	功能描述	字符串		20
	地点id	整数		20
	发布用户id	整数		20
讨论表	讨论id	整数		20
	发布用户id	整数		20
	地点id	整数		20
	讨论内容	字符串		140
讨论图片表	讨论图片id	整数		20
	图片URL	URL
	讨论id	整数		20
	文件名	字符串		20
	文件格式	字符串		20
	文件大小	文件格式		10MB
	创建时间	时间格式
	上传时间	时间格式
评论表	评论id	整数		20
	讨论id	整数		20
	评论内容	字符串		140
	评论者用户id	整数		20
	被评论者用户id	整数		20
轮播图片表	轮播图片id	整数		20
	地点id	整数		20
	轮播图片URL	URL

 

H.4.2.3  输入举例

       标记点表

       ‘00000001’,’思源餐厅’,’103.935210’,’30.753084’,某食堂，位于二楼’

      

       用户表

       ‘00000002’,’https://weixinxiaochengxu.luozijian.com/user/2/image.jpg’,’hanbing’,’ 571ae9d6c3aefd7880c408ccf632257f’

 

       功能表

       ‘00000003’,’餐厅’,’00000001’,’00000002’

 

       讨论表

       ‘00000004’,’00000002’.’00000001’,’思源的饭真难吃’

H.4.3  输出

H.4.3.1  输出数据的现实背景

说明输出数据的现实背景，主要是：为校园地图提供论坛显示服务

1. 使用──发布者查看讨论以及评论的显示状态；

        查询校园地图的功能介绍；

            用户查看自己的历史关注。

b、使用频度──随机的

c、媒体──手机客户端

d、质量管理──例如关于合理性检验，出错纠正的规定；

e、支配──管理人员对所拥有的权限数据的删除

 

H.4.3.2  输出格式

 

表名	属性	类型	精度	长度
标记点表	标记点id	整数		20
	标记点名	字符串		20
	经度	浮点类型	6	9
	纬度	浮点类型	6	9
	地点描述	字符串		20
用户表	用户id	整数		20
	用户头像URL	URL
	用户昵称	字符串		20
	用户哈希名	字符串		20
功能表	功能id	整数		20
	功能描述	字符串		20
	地点id	整数		20
	发布用户id	整数		20
讨论表	讨论id	整数		20
	发布用户id	整数		20
	地点id	整数		20
	讨论内容	字符串		140
讨论图片表	讨论图片id	整数		20
	图片URL	URL
	讨论id	整数		20
	文件名	字符串		20
	文件格式	字符串		20
	文件大小	文件格式		10MB
	创建时间	时间格式
	上传时间	时间格式
评论表	评论id	整数		20
	讨论id	整数		20
	评论内容	字符串		140
	评论者用户id	整数		20
	被评论者用户id	整数		20
轮播图片表	轮播图片id	整数		20
	地点id	整数		20
	轮播图片URL	URL

 

H.4.3.3  输出举例

标记点表

       ‘00000001’,’思源餐厅’,’103.935210’,’30.753084’,某食堂，位于二楼’

      

       用户表

       ‘00000002’,’https://weixinxiaochengxu.luozijian.com/user/2/image.jpg’,’hanbing’,’ 571ae9d6c3aefd7880c408ccf632257f’

 

       功能表

       ‘00000003’,’餐厅’,’00000001’,’00000002’

 

       讨论表

       ‘00000004’,’00000002’.’00000001’,’思源的饭真难吃’

 

H.4.4  文卷查询

1. 数据库查询的初始化：建立如下数据表

表名	查询
标记位置表	标记位置的标记名，经度，纬度，地点描述的精准查询
讨论表	发布者用户id，标记位置id，讨论文字内容的精准查询
功能表	功能描述/标签,标记点id,发布者用户id的精准查询
讨论图片表	讨论id,讨论图片的URL的精准查询
用户表	用户头像URL，哈希用户名称的精准查询，用户昵称的模糊查询
评论表	讨论id,评论内容，回复者id,被回复者id的精准查询

（2） 数据库查询的准备：生成相应的表

举例：本软件系统数据库采用django框架编写设计，所以命令行如下：

Python manage.py makemigrations

Python manage.py migrate

 

在数据库中检查对应表格是否已经生成

1. 数据库查询：对数据的增删改查
   1. 增

Python 代码如下：

Models.UserInfo.objects.create(user=’luozijian’,pwd=’123456’)

1. 1. 删

Python 代码如下：

Models.UserInfo.objects.filter(user=’luozijian’).delete()

1. 1. 改

Python 代码如下：

Models.UserInfo.objects.filter(user=’luozijian’).update(pwd=’520’)

1. 1. 查

Python 代码如下：

Models.UserInfo.objects.all().values(‘user’)

H.4.5  出错处理和恢复

    该软件系统具有数据检错能力。具体细节如下：

（1）输入文字内容时，输入字符会提示超出数量错误，重新输入。

（2）图片格式参数设计，只对主流图片格式接受，其余形式则只会提醒格式错误。

（3）发布相应有效，根据最后的发布状态判断，响应是否成功。

 

H.4.6  终端操作

支持软件：微信客户端

安装该小程序，即可启用校园地图的功能