拆分RAG用户文档为可维护分册结构
变更项: 1. 新增 docs/rag 目录及 README 索引,定义分册用途与维护规则。 2. 拆分用户文档为五个专题文件:快速开始、指令清单、管理员指南、FAQ、逐插件详解模板。 3. 保留用户向表达,便于后续仅维护受影响章节,不必整份重写。 4. 补充RAG落地约定(分片策略与元数据建议),便于直接接入向量库。
This commit is contained in:
29
docs/rag/00_快速开始.md
Normal file
29
docs/rag/00_快速开始.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# 00 快速开始
|
||||
|
||||
## 你先做这三步
|
||||
|
||||
1. 发送 `菜单`
|
||||
2. 发送 `菜单 指令清单`
|
||||
3. 发送 `菜单 状态`(管理员)
|
||||
|
||||
## 你需要知道
|
||||
|
||||
1. 功能是“按群开关”的:A群可用,不代表B群可用
|
||||
2. 同一功能通常有多个命令别名
|
||||
3. 部分命令需要管理员权限
|
||||
|
||||
## 支持 @ 询问
|
||||
|
||||
群里可直接问:
|
||||
|
||||
- `@机器人 功能清单`
|
||||
- `@机器人 指令清单`
|
||||
- `@机器人 这个怎么用`
|
||||
|
||||
## 最快试用组合
|
||||
|
||||
1. `签到`
|
||||
2. `全球新闻`
|
||||
3. `点歌 稻香`
|
||||
|
||||
最后更新:2026-04-16
|
||||
65
docs/rag/01_指令清单_按场景.md
Normal file
65
docs/rag/01_指令清单_按场景.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# 01 指令清单(按场景)
|
||||
|
||||
> 说明:以下是系统支持命令。你所在群实际可用项以 `菜单 指令清单` 为准。
|
||||
|
||||
## 菜单与帮助
|
||||
|
||||
- `菜单`
|
||||
- `功能菜单`
|
||||
- `菜单 指令清单`
|
||||
- `菜单 状态`
|
||||
|
||||
## AI 对话与绘图
|
||||
|
||||
- `聊天 你的问题`
|
||||
- `AI绘图 描述词`
|
||||
- `绘图 描述词`
|
||||
- `画图 描述词`
|
||||
- `生成图片 描述词`
|
||||
|
||||
## 新闻与天气
|
||||
|
||||
- `全球新闻` `国际新闻` `环球新闻` `政经新闻` `政治经济新闻`
|
||||
- `天气 城市`
|
||||
- `订阅天气 城市`
|
||||
- `取消订阅 城市`
|
||||
|
||||
## 音乐与娱乐
|
||||
|
||||
- `点歌 歌名`
|
||||
- `猜歌名`
|
||||
- `潜水排行`
|
||||
|
||||
## 图片与视频
|
||||
|
||||
- `图来` `秀人` `美图` `随机图片`
|
||||
- `美腿` `腿来`
|
||||
- `猛男` `肌肉` `帅哥`
|
||||
- `黑丝视频` `黑丝` `来个黑丝` `搞个黑丝`
|
||||
- 抖音链接:直接发送
|
||||
|
||||
## 积分与签到
|
||||
|
||||
- 签到:`签到` `每日签到` `qd` `上班` `牛马`
|
||||
- 补签:`补签` `续签`
|
||||
- 积分:`我的积分` `积分排行`
|
||||
- 转账:`积分转账 100 @某人`
|
||||
- 互动:`打劫 @某人` `保释 @某人`
|
||||
|
||||
## 游戏任务
|
||||
|
||||
- `/s` `/t` `/a 任务ID 答案` `/r` `/l` `/h`
|
||||
|
||||
## 群与跨群
|
||||
|
||||
- `#加群 关键词`
|
||||
- `#加群配置 ...`
|
||||
- `#创建跨群` `#添加群` `#查看跨群列表` `#查看跨群` `#退出跨群` `#解散跨群`
|
||||
|
||||
## 推送与系统
|
||||
|
||||
- `推送` `消息推送` `定时推送`
|
||||
- `更新系统` `系统更新` `重启系统` `更新重启`
|
||||
- `插件 列表` `插件 启用 插件名` `插件 禁用 插件名` `插件 信息 插件名`
|
||||
|
||||
最后更新:2026-04-16
|
||||
34
docs/rag/02_管理员指南.md
Normal file
34
docs/rag/02_管理员指南.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# 02 管理员指南
|
||||
|
||||
## 功能开关
|
||||
|
||||
- 查看:`菜单 状态`
|
||||
- 启用:`菜单 启用 序号` 或 `菜单 启用 功能名`
|
||||
- 关闭:`菜单 关闭 序号` 或 `菜单 关闭 功能名`
|
||||
|
||||
示例:
|
||||
|
||||
- `菜单 启用 1`
|
||||
- `菜单 关闭 2`
|
||||
|
||||
## 群管理员维护
|
||||
|
||||
- `菜单 管理员 列表`
|
||||
- `菜单 管理员 添加 wxid`(支持@)
|
||||
- `菜单 管理员 删除 wxid`(支持@)
|
||||
|
||||
## 插件管理
|
||||
|
||||
- `插件 列表`
|
||||
- `插件 启用 插件模块名`
|
||||
- `插件 禁用 插件模块名`
|
||||
- `插件 重载 插件模块名`
|
||||
- `插件 信息 插件模块名`
|
||||
|
||||
## 发布与回滚建议
|
||||
|
||||
1. 先在测试群验证:`菜单 指令清单` 是否正确
|
||||
2. 再灰度到核心群
|
||||
3. 出现异常优先停用冲突插件,再定位日志
|
||||
|
||||
最后更新:2026-04-16
|
||||
35
docs/rag/03_FAQ_故障排查.md
Normal file
35
docs/rag/03_FAQ_故障排查.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# 03 FAQ 与故障排查
|
||||
|
||||
## Q1 命令没反应
|
||||
|
||||
按顺序检查:
|
||||
|
||||
1. 命令拼写是否正确(优先复制 `菜单 指令清单`)
|
||||
2. 本群是否启用了该功能(`菜单 状态`)
|
||||
3. 是否为管理员命令
|
||||
4. 是否处于冷却或静默时段
|
||||
|
||||
## Q2 别人能用我不能用
|
||||
|
||||
1. 你是否漏了参数(如 `@用户`、关键字)
|
||||
2. 你是否在私聊触发了仅群聊可用命令
|
||||
3. 权限是否不足
|
||||
|
||||
## Q3 AI 回复了,其他插件没触发
|
||||
|
||||
已支持非阻断模式;若仍冲突,检查插件触发条件和优先链。
|
||||
|
||||
## Q4 如何快速知道本群能干什么
|
||||
|
||||
发送:`菜单 指令清单`
|
||||
|
||||
## Q5 如何反馈问题
|
||||
|
||||
反馈时请附:
|
||||
|
||||
1. 群ID/场景(群聊或私聊)
|
||||
2. 触发命令原文
|
||||
3. 预期结果与实际结果
|
||||
4. 发生时间
|
||||
|
||||
最后更新:2026-04-16
|
||||
44
docs/rag/04_功能详解_逐插件.md
Normal file
44
docs/rag/04_功能详解_逐插件.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# 04 功能详解(逐插件模板)
|
||||
|
||||
> 这个文件用于持续新增。每新增一个插件,按下面模板加一段。
|
||||
|
||||
## 模板
|
||||
|
||||
### 插件名
|
||||
|
||||
- 功能定位:
|
||||
- 触发命令:
|
||||
- 参数说明:
|
||||
- 返回示例:
|
||||
- 权限要求:普通成员 / 管理员
|
||||
- 常见失败原因:
|
||||
- 关联功能开关(Feature):
|
||||
- 备注:
|
||||
|
||||
---
|
||||
|
||||
## RobotMenu(功能菜单)
|
||||
|
||||
- 功能定位:展示本群可用功能与命令
|
||||
- 触发命令:`菜单` `功能菜单` `菜单 指令清单` `菜单 状态`
|
||||
- @问答:`@机器人 功能清单` `@机器人 指令清单` `@机器人 怎么用`
|
||||
- 权限要求:
|
||||
- 查看菜单:普通成员可用
|
||||
- 开关管理:管理员
|
||||
- 常见失败原因:本群未启用机器人总开关
|
||||
|
||||
## PluginManager(插件管理)
|
||||
|
||||
- 功能定位:启停、重载、查询插件
|
||||
- 触发命令:`插件 列表` `插件 启用 插件名` `插件 禁用 插件名` `插件 信息 插件名`
|
||||
- 权限要求:管理员
|
||||
- 风险提示:生产环境重载前建议先在测试群验证
|
||||
|
||||
## AI Auto Response(拟人群聊)
|
||||
|
||||
- 功能定位:群聊拟人回复
|
||||
- 触发方式:文本消息自然触发(可结合@)
|
||||
- 行为说明:当前为非阻断模式,不拦截后续插件处理
|
||||
- 常见失败原因:群权限关闭、夜间策略、冷却策略、队列拥堵
|
||||
|
||||
最后更新:2026-04-16
|
||||
27
docs/rag/README.md
Normal file
27
docs/rag/README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# ABOT RAG 文档索引
|
||||
|
||||
本目录用于构建用户向知识库(RAG)。
|
||||
|
||||
## 文件清单
|
||||
|
||||
1. `00_快速开始.md`:新用户 30 秒上手
|
||||
2. `01_指令清单_按场景.md`:用户最关心的命令索引
|
||||
3. `02_管理员指南.md`:管理员开关与运维操作
|
||||
4. `03_FAQ_故障排查.md`:高频问题与定位步骤
|
||||
5. `04_功能详解_逐插件.md`:按插件沉淀的功能说明模板
|
||||
|
||||
## 维护规则
|
||||
|
||||
1. 新增用户功能:优先更新 `01` 和 `04`
|
||||
2. 新增管理员能力:优先更新 `02`
|
||||
3. 线上问题复盘:优先更新 `03`
|
||||
4. 大版本文案统一调整:更新 `00`
|
||||
|
||||
## RAG 分片建议
|
||||
|
||||
1. 按 `##` 标题切块
|
||||
2. 每块 300~800 中文字
|
||||
3. 重叠 80~120 字
|
||||
4. 元数据字段建议:`source` `section` `intent` `audience` `keywords` `updated_at`
|
||||
|
||||
最后更新:2026-04-16
|
||||
Reference in New Issue
Block a user