• 帮助文档
  • 一、 简介
  • 二、 创建帮助文档
  • 三、 最后

帮助文档

一、 简介

在经历这个专栏的学习之后，我想go-cqhttp+flask的学习也该告一段落了，因为有部分功能，如定时发送功能，以及纯异步高性能等功能的实现使用flask是有点难实现的。故，我打算，使用NoneBot2为框架，搭建一个高性能异步机器人。

对于用户来说，帮助文档是一个用户帮助中心，可以通过帮助页面查询到机器人的操作指南，机器人的使用方法、介绍，是产品不可或缺的文档。我们应该给我们的机器人创建一个帮助文档， 给用户一个操作指南。

那么，应该如何创建一个帮助文档呢？

1. 手动的输入
2. 程序生成

那么，这篇文章将使用手动输入的方式，来创建一个帮助文档。这时，又有一个问题了。我们应该使用什么语言来写帮助文档呢？

总不可能使用doc文件吧！好了，不卖关子了。这里使用的是markdown作为开发帮助文档的语言。

markdown的基本语法

二、 创建帮助文档

我们将创建完成后的所有使用方法都写入我们的帮助文档中，便于用户操作使用

[toc]

# 机器人帮助文档

## 一、 超级管理员

1. `/admin:add qq群号 qq群名`：添加qq群到数据库中，使得机器人支持该群
2. `/admin:get qq群号`：获取qq群号对应的权限信息
3. `/admin:show`：展示机器人支持的所有的qq群号
4. `/admin:close qq群号`：机器人对该群不支持，可以使用`add`开启
5. `/admin:delete qq群号`：从数据库中删除该qq群，使得机器人不会检测该群信息
6. `/admin:changeAuth qq群号 6位数字`：6位数字分别对应：聊天功能|入群欢迎|管理群|戳一戳|拓展功能|定时功能；0代表关闭，1 代表开启；同时，必须是6位数字哦！

## 二、 群管理员

1. `/admin:get`：查看本群机器人开启的权限
2. `/admin:change 6位数字`：6位数字分别对应：聊天功能|入群欢迎|管理群|戳一戳|拓展功能|定时功能；0代表关闭，1 代表开启；同时，必须是6位数字哦！

## 三、 普通成员

1. `/bing`：获取bing每日图片
2. `/随机图片`：获取随机一张图片
3. `/天气 city`：获取city城市的天气情况
4. `/send 内容`：提交优化机器人的建议
5. `/二次元`：获取随机的二次元图片
6. `/随机一言`：获取随机的一句毒鸡汤
7. `/段子`：随机获取一个搞笑的段子
8. `/历史`：获取历史的今天都发生了什么事情
9. `/短视频 url`：无水印视频解析，需要传入短视频的链接地址，暂时支持：抖音|快手|皮皮虾|小红书|哔哩等各类短视频去水印解析 
10. `/诗词`：获取一句随机的诗词
11. `/人生语录`：获取一句励志的句子
12. `/疫情 city`：获取city城市的疫情状况
13. `/农历`：获取今天的农历信息
14. `/简报`：获取每日简报，让你60分钟了解世界

## 四、小知识

### 1、 智能聊天

#### 1.1 私聊

直接发送消息即为开启智能聊天的功能

同时，此机器人还有一个戳一戳回复消息的功能，可以尝试一下哦！

#### 1.2 群聊

该群开启机器人的聊天功能后，艾特机器人发送消息，即为开启了智能聊天的功能

同时机器人还有戳一戳回复的功能，也是需要群管理员开启这个功能才可以使用的

### 2、 短视频链接获取

#### 2.1 电脑端

这里选取快手的视频为例，其余视频平台获取链接的方式类似：

![1663462830405](assert/1663462830405.png)

#### 2.2 移动端

移动端，由于我只有b站，所以使用b站作为演示

1. 随机打开一个视频，进入详情页

2. 点击分享按钮，分享链接

3. 获取链接

   发给任意的联系人，最后就可以得到一个链接了

4. 将这个链接配合命令发给机器人

   就可以得到视频的下载链接了

### 3、 权限

| 权限     | 说明                                                     |
| -------- | -------------------------------------------------------- |
| 聊天功能 | 是否开启机器人的智能聊天功能                             |
| 入群欢迎 | 是否开启新成员入群欢迎功能，欢迎语可以找开发者自定义哦！ |
| 管理群   | 是否开启管理群的功能(暂时还没完成)                       |
| 戳一戳   | 是否开启戳一戳回复功能                                   |
| 拓展功能 | 是否开启普通成员的一些小功能                             |
| 定时功能 | 是否开启定时发送消息功能                                 |

然后，在typora中选择一个好看的主题，导出为jpg格式，上传到服务器中。这个是我创建的帮助文档

三、 最后

go-cqhttp使用flask作为服务端开发的代码，我已经上传到GitHub上了，大家想要直接使用的可以去GitHub下载，进行数据库迁移后，就可以直接运行了

代码地址：https://github.com/liuzhongkun1/flask_/tree/main/bot

对于go-cqhttp+flask的学习，我们就像告一段落，下一篇文章，我将使用NoneBot2配合我们的go-cqhttp使用，实现高性能异步机器人