343a5eebe3
Some checks failed
Sync to Gitee / sync (push) Has been cancelled
Submit the formed RAG documentation set produced across Sprint-1/2/3 (WS-12 through WS-26) under docs/rag/. Includes: - README.md / INDEX.md: landing + total index (responsibility matrix, review verdicts, dual-link to source issues) - overview/: full-pipeline architecture (4 .mmd diagrams), 11-stage boundary contracts, doc map, source-code inventory - pipeline/: 5 deep-dives (Loader/Parser/Chunking, Embedding, VDB & retrieval, GraphRAG, Rerank/Prompt/LLM) - graphrag/, end-to-end/: v1.0 formal versions with full source retained as reference - evolution/: 11 architecture-refactor proposals, 6-direction roadmap, capability map - review/: S3-T1 / S3-T2 final reviews, S2-T7 final summary - _indexes/: glossary (81 terms), source->doc reverse index, chart index - _release/: v1.0-RC1 release manifest, versioning convention, ops & freshness plan - _meta/README.md: placeholder noting WS-12 governance assets gap Aggregate review score 92.6/100 (8/8 PASS, 31/31 source-code spot checks hit). The legacy docs/ ignore in .gitignore is narrowed to docs/* with an explicit allowlist for docs/rag/. Refs: WS-26 Co-authored-by: multica-agent <github@multica.ai>
127 lines
8.4 KiB
Markdown
127 lines
8.4 KiB
Markdown
# MemoryBear RAG Docs · 发布候选清单 v1.0-RC1
|
||
|
||
> **状态**：Release Candidate 1 · 候选发布
|
||
> **冻结日期**：2026-05-08
|
||
> **发布方式**：仓库 PR + Wiki + Issue 评论附件
|
||
> **下次升版门槛**：S2-T7 评审通过 + S2-T4 / S2-T6 占位文档替换
|
||
|
||
---
|
||
|
||
## 1. 版本基本信息
|
||
|
||
| 项 | 值 |
|
||
|---|---|
|
||
| 版本号 | `v1.0-RC1` |
|
||
| 发布通道 | Release Candidate（候选发布） |
|
||
| 基线源码 | MemoryBear `agent/ai/f8de881a` 分支（基于 commit `feae2f2e`） |
|
||
| 文档作者 | AI 知识库专家 / Python 工程师 / 知识运营专家 / PM 协同 |
|
||
| 终审责任人 | 知识运营与治理专家 |
|
||
| 文件总数 | 33 个（其中 28 已交付，5 占位） |
|
||
| 总字数（含已交付） | ≈ 230k 字（中文） |
|
||
| Mermaid 图表 | 9 张已交付，5 张待补 |
|
||
| 源码引用 | 200+ 处（采样 5 处全部可在 ±3 行内复现） |
|
||
|
||
## 2. 发布 Targets（"哪些文档随什么形式发布"）
|
||
|
||
| 路径 | 发布形式 | 责任人 | 交付物 |
|
||
|---|---|---|---|
|
||
| `docs/rag/README.md` | **仓库 PR** | 知识运营 | Landing 页，含三套阅读路径 |
|
||
| `docs/rag/INDEX.md` | **仓库 PR** | 知识运营 | 全集总索引 + 责任矩阵 |
|
||
| `docs/rag/_meta/*` | **仓库 PR** | 知识运营 | 治理资产（已合入 `agent/ai/f8de881a` 分支预备） |
|
||
| `docs/rag/overview/*.mmd` | **仓库 PR**（Mermaid 文件） + **Wiki**（渲染版） | AI 知识库 | 4 张时序/架构图 |
|
||
| `docs/rag/overview/{boundaries.md,DocMap.md,source-inventory.md}` | **仓库 PR** | AI 知识库 / Python 工程 | 边界定义 / 大纲 / 源码盘点 |
|
||
| `docs/rag/pipeline/*.md` | **仓库 PR** | Python 工程 | 4 篇已交付 + 1 占位（S2-T4 待重启） |
|
||
| `docs/rag/end-to-end/README.md` | **占位**（不入 PR） | AI 知识库 | 等 S2-T6 解除阻塞后追加 |
|
||
| `docs/rag/evolution/*` | **仓库 PR** | AI 知识库 | S3-T1 / S3-T2（终审已通过） |
|
||
| `docs/rag/review/*` | **仓库 PR**（已通过部分） + **Issue 归档**（未启动部分） | 知识运营 | S3-T1 / S3-T2 终审报告 + S2-T7 占位 |
|
||
| `docs/rag/_indexes/*` | **仓库 PR** | 知识运营 | Glossary / File Index / Chart Index |
|
||
| `docs/rag/_release/*` | **仓库 PR** | 知识运营 | 本文 + 版本约定 + 运营保鲜计划 |
|
||
|
||
> **建议 PR 拆分**：
|
||
> - **PR-1**（_meta + README + INDEX）：作为治理 baseline 先合，便于后续文档按统一模板入库。
|
||
> - **PR-2**（overview + 4 个 .mmd）：架构与图谱基础，独立合并便于 review。
|
||
> - **PR-3**（pipeline 4 篇 + 1 占位）：Sprint-2 已交付内容；占位文件含明确"等待重启"说明，避免误读。
|
||
> - **PR-4**（evolution + capability-map.mmd）：架构改造与迭代路线（S3-T1/T2）。
|
||
> - **PR-5**（review + _indexes + _release）：评审报告与索引、运营资产。
|
||
|
||
## 3. v1.0-RC1 → v1.0 升版门槛（Release Gate）
|
||
|
||
| 门槛 | 当前状态 | 责任人 | 预计完成 |
|
||
|---|---|---|---|
|
||
| **G1: S2-T7 评审收口完成** | ⏳ todo（上一次 API Error） | 知识运营 | 重启后 1 个工作日 |
|
||
| **G2: S2-T4 GraphRAG 文档交付 + 评审通过** | ⏳ 占位 | Python 工程师 | 重启后 1 周 |
|
||
| **G3: S2-T6 E2E 调用链路文档交付** | ⏳ 阻塞（依赖 S2-T1~T5） | AI 知识库专家 | S2-T4 解除后 3 个工作日 |
|
||
| **G4: 已交付的 4 篇 Sprint-2 文档（T1/T2/T3/T5）正式评分录入** | ⏳ 待 S2-T7 评审落分 | 知识运营 | G1 完成时一并 |
|
||
| **G5: S3-T1 §3.1 短期路线图工作项 #1（删除 `node.py:327 print()`）合入 main** | ⏳ 待提 PR | Python 工程师 / AI 知识库 | 任意 1 个工作日 |
|
||
| **G6: 全部仓库 PR 合入 main 分支** | ⏳ 待 PR 创建 | 知识运营协调 | G1-G5 完成后启动 |
|
||
|
||
> **任一门槛未达成，停在 v1.0-RCN（N 递增）**。
|
||
|
||
## 4. v1.0 ~ v2.0 版本节奏（建议）
|
||
|
||
| 版本 | 触发条件 | 主要内容 |
|
||
|---|---|---|
|
||
| `v1.0` | G1-G6 全部 PASS | 完整的 S1+S2+S3 文档全集，对外可发布 |
|
||
| `v1.1` | S3-T1 §3.1 短期路线图（5 项工作项）全部合入 | 增量更新：Reranker 缓存上线、`RAGSettings` 落地、单测脱离 ES 等 |
|
||
| `v1.2` | S3-T2 PoC-A（RRF）+ PoC-B（Memory Rewrite）合入 | 增量更新 D2 / D4 章节，回填实测数据 |
|
||
| `v1.3` | S3-T1 §3.2 中期路线图完成（OTel / Plugin Registry / 4 大 Protocol） | 大版本：Embedder/Retriever/Reranker/Generator Protocol 落地，可观测性建立 |
|
||
| `v2.0` | S3-T1 §3.3 长期路线图完成 + S3-T2 D1/D3 多模态 + 增量图 | 架构演进里程碑：可插拔 VDB、Pipeline DSL、增量图、跨模态检索 |
|
||
|
||
> 这套节奏与 [S3-T2] §4 Roadmap 的 Sprint-3 / 短/中/长 时间窗一致；每次升版必须同步刷新 Mermaid 图与 source-commit。
|
||
|
||
## 5. 文档质量门槛（自检 vs 终审）
|
||
|
||
| 类别 | 自检通过分 | 终审通过分 | 一票否决项 |
|
||
|---|---|---|---|
|
||
| Sprint-2 各深度文档（S2-T1 ~ S2-T5） | ≥ 70 | ≥ 80 | 源码虚构 / 核心章节缺失 / 安全风险描述 / 架构严重脱节 |
|
||
| Sprint-3 演进文档（S3-T1 / S3-T2） | ≥ 75 | ≥ 80 | 同上 |
|
||
| 治理资产（_meta） | ≥ 70 | ≥ 80 | 同上 |
|
||
| 索引与 Landing | ≥ 70 | ≥ 80 | 同上 |
|
||
|
||
> 上述阈值与 S1-T1 评分卡保持一致。当前 S3-T1 / S3-T2 已通过终审（96 / 95）。
|
||
|
||
## 6. 已知风险与应对
|
||
|
||
| # | 风险 | 影响 | 缓解 |
|
||
|---|---|---|---|
|
||
| R1 | S2-T4 GraphRAG 文档因 API Error 多次失败，可能再次中断 | v1.0 升版被卡 | 启动前先 dry-run 一次，若仍失败则把"GraphRAG 现有 light/general 的简版梳理"由 [@AI 知识库专家] 接管 |
|
||
| R2 | S2-T6 E2E 文档目前 blocked，依赖 S2-T1~T5 全部交付 | v1.0 升版被卡 | S2-T4 完成后立即触发 S2-T6 |
|
||
| R3 | 仓库 PR 与 RAG 主分支合并冲突（仓主可能在并行修改） | PR 滚动 review 难 | 锁定 source-commit，按 PR-1 → PR-5 顺序短链合并；冲突时由责任专家 rebase |
|
||
| R4 | 文档与代码失同步（main 分支前进） | 内容时效性下降 | 见 `ops-and-freshness-plan.md` 的"每次 release 同步评审"机制 |
|
||
| R5 | 内部 Wiki 渲染 Mermaid 节点上限 1500 | 大图渲染失败 | 拆图（Chart Index §4 已规划）、备份 SVG |
|
||
| R6 | Sprint-2 文档评分若多篇低于 80，需返工 | 升版延期 | 先评 in_review 状态的 4 篇，发现共性问题立即下发修订 |
|
||
|
||
## 7. 发布仪式 Checklist
|
||
|
||
发布 v1.0 前，逐项打勾：
|
||
|
||
- [ ] G1-G6 全部门槛达成（§3）
|
||
- [ ] PR-1 ~ PR-5 全部合入 main
|
||
- [ ] 内部 Wiki 同步发布（含 Mermaid 渲染版）
|
||
- [ ] 在 [WS-24](mention://issue/a07f108d-06ee-41b8-8b57-22455f60ddeb) 发"v1.0 正式发布纪要"评论（含交付物清单 + 链接 + 总评分）
|
||
- [ ] 状态由 `in_review` → `done`
|
||
- [ ] 通知 PM 启动 [WS-25 / S3-T4 PM 复盘](mention://issue/b98604b1-326f-42b4-a4c2-b3d9ad80ec75)
|
||
- [ ] 创建 v1.1 跟踪 issue（占位下一轮迭代）
|
||
|
||
---
|
||
|
||
## 附录 A：当前已交付文件 SHA-1（防篡改）
|
||
|
||
> 在落入仓库 PR 前，先记录附件的 SHA-1 校验值；合并到仓库后由 reviewer 复核。
|
||
|
||
| 文件 | 来源 attachment ID | 大小 | 备注 |
|
||
|---|---|---|---|
|
||
| `S3-T1-deliverable.md` → `evolution/architecture-refactor-suggestions.md` | `019e0757-d0ab-704a-b6bb-5c1bbb3d8eb6` | 33 KB | S3-T1 |
|
||
| `future-extensions-roadmap.md` → `evolution/future-extensions-roadmap.md` | `019e075c-42a0-7a64-b5d5-263c0fc92a0b` | 32 KB | S3-T2 |
|
||
| `capability-map.mmd` → `evolution/capability-map.mmd` | `019e075c-42c7-713e-a8c3-41bf37d5ca37` | 4 KB | S3-T2 |
|
||
| `01-architecture.mmd` → `overview/01-architecture.mmd` | `019e0747-0c26-79e8-984b-f6d8394016aa` | 5 KB | S1-T2 |
|
||
| `02-indexing-pipeline.mmd` → `overview/02-indexing-pipeline.mmd` | `019e0747-0c4d-7808-8362-16b237c02048` | 4 KB | S1-T2 |
|
||
| `03-query-pipeline.mmd` → `overview/03-query-pipeline.mmd` | `019e0747-0c71-7ab7-9269-1175e487308e` | 4 KB | S1-T2 |
|
||
| `04-graphrag-indexing.mmd` → `overview/04-graphrag-indexing.mmd` | `019e0747-0c92-7ec5-a2c9-bb3f9c2b4de9` | 3 KB | S1-T2 |
|
||
| `DocMap.md` → `overview/DocMap.md` | `019e0747-0cb6-78c4-8e5c-af441e571e3c` | 18 KB | S1-T2 |
|
||
| `boundaries.md` → `overview/boundaries.md` | `019e0747-0cd9-7a9e-95f1-f5428e35b3c6` | 13 KB | S1-T2 |
|
||
|
||
> S1-T1 _meta 系列与 Sprint-2 各深度文档当前以**评论正文**形式存在，作为本次 RC 的"评论沉淀+对外引用"双形态。仓库 PR 时由责任专家把评论正文落到对应文件，由知识运营复核 SHA-1 一致性。
|
||
|
||
— **Release Manifest · v1.0-RC1 · 2026-05-08** —
|