|
|
|
# 产品研发 RAG 飞书目录页文案
|
|
|
|
|
|
|
|
## 一、文档说明
|
|
|
|
|
|
|
|
这套文档用于统一沉淀产品研发 RAG 知识库相关方案、维护流程、Dify 接入方式和后续接手说明。
|
|
|
|
|
|
|
|
目标有四个：
|
|
|
|
- 支撑产品逻辑问答
|
|
|
|
- 支撑版本变更追溯
|
|
|
|
- 支撑需求 AI 预评审
|
|
|
|
- 为后续前后端代码知识库建设提供产品语义底座
|
|
|
|
|
|
|
|
项目仓库地址：
|
|
|
|
- `http://gitlab.dajiazhongyi.com/xuweikang/RAG_`
|
|
|
|
|
|
|
|
当前约定：
|
|
|
|
- 底层知识资产是一套
|
|
|
|
- Dify 按用途拆成多个知识库视图
|
|
|
|
- 培训文档是产品主事实源
|
|
|
|
- Figma 和测试用例补交互、边界和异常
|
|
|
|
- 高优先专项文档用于补专项规则
|
|
|
|
|
|
|
|
## 二、建议置顶文档
|
|
|
|
|
|
|
|
建议飞书目录页固定挂这几份：
|
|
|
|
|
|
|
|
1. `产品研发RAG_总体方案与实施手册`
|
|
|
|
2. `产品研发RAG_增量更新与Dify维护手册`
|
|
|
|
3. `产品研发RAG_接手说明`
|
|
|
|
|
|
|
|
如果团队需要直接查看知识内容，可补挂：
|
|
|
|
|
|
|
|
4. `版本变更总览`
|
|
|
|
5. `高优先参考文档`
|
|
|
|
|
|
|
|
## 三、更新策略
|
|
|
|
|
|
|
|
每次有新版本、新专项规则文档或后台代码变化时，按下面顺序更新：
|
|
|
|
|
|
|
|
1. 原始资料入库
|
|
|
|
2. 运行知识库重建脚本
|
|
|
|
3. 检查生成结果
|
|
|
|
4. 更新 Dify 对应知识库
|
|
|
|
5. 同步飞书文档
|
|
|
|
|
|
|
|
资料放置规则：
|
|
|
|
- 培训文档 PDF：`pdf/`
|
|
|
|
- 测试用例 XML：`testCase/`
|
|
|
|
- Figma 链接：`inputs/figma/<版本号>/links.txt`
|
|
|
|
- 高优先专项文档：`inputs/priority_refs/`
|
|
|
|
- 后台代码仓库：通过脚本传入本地路径
|
|
|
|
|
|
|
|
常用命令：
|
|
|
|
|
|
|
|
```bash
|
|
|
|
bash scripts/rebuild_version_kb.sh <版本号> /Users/xwk/Downloads/studio-server2
|
|
|
|
```
|
|
|
|
|
|
|
|
如果只是新增专项高优先参考文档：
|
|
|
|
|
|
|
|
```bash
|
|
|
|
python3 scripts/build_dify_import_pack.py
|
|
|
|
```
|
|
|
|
|
|
|
|
## 四、文件更新时间说明
|
|
|
|
|
|
|
|
建议每份飞书主文档顶部保留下面这些信息：
|
|
|
|
|
|
|
|
- 状态：生效中 / 待更新 / 已归档
|
|
|
|
- 最近更新时间：YYYY-MM-DD
|
|
|
|
- 最近更新版本：如 `v4.58.0`
|
|
|
|
- 更新范围：如“认证流程、问诊规则、版本总览”
|
|
|
|
- 更新责任人：姓名或角色
|
|
|
|
|
|
|
|
推荐模板：
|
|
|
|
|
|
|
|
```text
|
|
|
|
状态：生效中
|
|
|
|
最近更新时间：2026-03-19
|
|
|
|
最近更新版本：v4.57.3
|
|
|
|
更新范围：产品主知识库、版本总览、Dify 导入包
|
|
|
|
维护入口：GitLab 仓库 http://gitlab.dajiazhongyi.com/xuweikang/RAG_
|
|
|
|
```
|
|
|
|
|
|
|
|
## 五、代码知识库怎么用
|
|
|
|
|
|
|
|
代码知识库不是替代产品知识，而是补充“系统实际上怎么实现”。
|
|
|
|
|
|
|
|
使用原则：
|
|
|
|
- 产品知识定义“产品应该是什么”
|
|
|
|
- 代码知识补充“系统怎么实现、受什么限制”
|
|
|
|
- 预评审时同时参考两者
|
|
|
|
- 代码知识不覆盖产品定义
|
|
|
|
|
|
|
|
适合回答的问题：
|
|
|
|
- 这个需求可能影响哪些接口？
|
|
|
|
- 会影响哪些状态、枚举、权限或异常？
|
|
|
|
- 哪些实现约束需要回归验证？
|
|
|
|
- 哪些逻辑只在后端实现里存在？
|
|
|
|
|
|
|
|
## 六、Dify 怎么用
|
|
|
|
|
|
|
|
当前 Dify 推荐使用 3 个知识库：
|
|
|
|
|
|
|
|
1. 产品主知识库
|
|
|
|
2. 版本与预评审知识库
|
|
|
|
3. 后台实现补充知识库
|
|
|
|
|
|
|
|
推荐参数：
|
|
|
|
- 分段标识符：`\n\n`
|
|
|
|
- 分段最大长度：`1200`
|
|
|
|
- 分段重叠长度：`100`
|
|
|
|
- 索引方式：`高质量`
|
|
|
|
- 检索方式：`混合检索`
|
|
|
|
- Top K：`5`
|
|
|
|
- Rerank：能开就开
|
|
|
|
- Embedding：`text-embedding-v4`
|
|
|
|
|
|
|
|
更新 Dify 时：
|
|
|
|
- 产品规则变化：替换对应模块主知识文件
|
|
|
|
- 版本变化：至少替换“版本变更总览”
|
|
|
|
- 新专项规则：上传新的高优先参考文件
|
|
|
|
- 后台代码变化：替换后台实现补充知识库文件
|
|
|
|
|
|
|
|
## 七、每次版本更新后的必做事项
|
|
|
|
|
|
|
|
每次版本更新后，至少完成以下动作：
|
|
|
|
|
|
|
|
1. 重建本地产物
|
|
|
|
2. 检查 `dist/dify_import/` 和 `dist/backend_code/`
|
|
|
|
3. 更新 Dify 受影响知识库文件
|
|
|
|
4. 同步飞书主文档
|
|
|
|
5. 如有明显版本变化，同步飞书中的“版本变更总览”
|
|
|
|
6. 如有专项规则新增，同步专项文档
|
|
|
|
|
|
|
|
## 八、维护入口
|
|
|
|
|
|
|
|
后续维护统一以仓库中的以下文件为准：
|
|
|
|
|
|
|
|
- `README.md`
|
|
|
|
- `docs/产品研发RAG_总体方案与实施手册.md`
|
|
|
|
- `docs/产品研发RAG_增量更新与Dify维护手册.md`
|
|
|
|
- `docs/产品研发RAG_接手说明.md`
|
|
|
|
- `skills/product-rag-maintainer/SKILL.md`
|
|
|
|
|
|
|
|
建议飞书文档说明一句：
|
|
|
|
|
|
|
|
```text
|
|
|
|
飞书文档用于团队阅读与协作，源码事实以 GitLab 仓库中的 docs/ 与 dist/ 产物为准。
|
|
|
|
``` |
...
|
...
|
|
