用 RAG 做项目文档问答：从零搭一个 Demo

wuwenzen@outlook.com (wuwj) — Sun, 10 Sep 2023 00:00:00 +0000

之前写过一篇「文档问答助手」的早期尝试，这次想更系统地从 RAG 角度，把整个过程讲清楚。

RAG（Retrieval-Augmented Generation）= 检索增强生成
简单说就是：先从你自己的文档里检索相关内容，再让大模型基于这些内容生成答案。

这篇文章以「项目文档问答」为例，从零搭一个小 Demo。

1. 目标：让大模型「读得懂」我们的项目文档

设定目标：

知识来源：代码仓库中的 README、设计文档、接口说明等；
使用方式：在一个 Web 界面里提问，例如：
- 「私募投资人小程序支持哪些登陆方式？」
- 「电子合同模块的签署流程有哪些关键步骤？」
期望回答：
- 基本准确；
- 回答中能指出「来自哪份文档」。

约束条件：

不追求「端到端生产可用」，先搭一个可演示、可验证的 Demo；
优先用云端 Embedding + 向量库，而不是自己训模型。

2. 文档准备与切分

2.1 文档来源

Git 仓库中的 Markdown：docs/ 目录、各项目 README；
内部 Wiki 导出的 HTML/Markdown；
部分 API 文档（Swagger/OpenAPI 转文本）。

统一先转成 Markdown/纯文本，方便处理。

2.2 切分策略

RAG 很关键的一步是「chunking」，即把长文档切成小段。
我们采用的是：

按标题结构 + 字数混合切分；
每段控制在 300–600 字；
保留上级标题用于提供上下文。

示例结构：

{
  "docId": "fund-investor-miniapp",
  "docTitle": "信e募投资人小程序技术方案",
  "sectionPath": ["2. 技术架构", "2.1 前端技术栈"],
  "content": "前端采用 Vue3 + uni-app...",
  "index": 12
}

经验：

项目文档 on Saiga

用 RAG 做项目文档问答：从零搭一个 Demo

1. 目标：让大模型「读得懂」我们的项目文档

2. 文档准备与切分

2.1 文档来源

2.2 切分策略