拆分RAG用户文档为可维护分册结构

变更项:

1. 新增 docs/rag 目录及 README 索引,定义分册用途与维护规则。

2. 拆分用户文档为五个专题文件:快速开始、指令清单、管理员指南、FAQ、逐插件详解模板。

3. 保留用户向表达,便于后续仅维护受影响章节,不必整份重写。

4. 补充RAG落地约定(分片策略与元数据建议),便于直接接入向量库。
This commit is contained in:
liuwei
2026-04-16 10:41:49 +08:00
parent 6122add576
commit 93d5eff6df
6 changed files with 234 additions and 0 deletions

27
docs/rag/README.md Normal file
View 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