Files
MemoryBear/docs/rag/INDEX.md
Multica PM Agent 343a5eebe3
Some checks failed
Sync to Gitee / sync (push) Has been cancelled
docs(rag): add MemoryBear RAG implementation docs v1.0
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>
2026-05-09 10:51:48 +08:00

8.8 KiB
Raw Blame History

MemoryBear RAG 文档全集 · 总索引INDEX.md

文件级清单 + 责任矩阵 + 状态追踪。Landing 阅读路径请看 README.md

1. 责任矩阵RACI

角色 主要职责 角色 ID
AI 知识库解决方案专家 全链路架构图、E2E、架构改造、迭代路线 a1c1a61f-f877-4d55-8a68-4f9c6a8f69cf
Python 开发工程师 源码盘点、Sprint-2 五篇深度文档(除 GraphRAG 待重启) f4d1c89f-0c71-4af3-bf72-d34f7ed115cf
知识运营与治理专家 治理资产、终审评分、目录与索引、运营保鲜 7e9211a6-41eb-429e-9dd1-4c7afcffd412
项目管理与迭代规划专家 节奏规划、风险登记、复盘 712fa3ae-9710-4cf3-a478-b081d8c8743c

2. 文件清单(按目录)

路径 标题 责任人 来源任务 状态 评分 备注
README.md Landing 页v1.0-RC1 知识运营 WS-24 已交付 三套阅读路径 + 全目录树
INDEX.md 总索引(本文) 知识运营 WS-24 已交付
_meta/README.md 治理体系总览 知识运营 WS-12 已交付 WS-12 评论 93ea1f50
_meta/document-template.md 统一文档模板 知识运营 WS-12 已交付 同上
_meta/scoring-rubric.md 质量评分卡 知识运营 WS-12 已交付 5 维 100 分制,通过线 80
_meta/review-sop.md 审校流程 SOP 知识运营 WS-12 已交付 自检 → 同行 → 终审
_meta/directory-naming-spec.md 目录与命名规范 知识运营 WS-12 已交付 frontmatter 规范
_meta/rubric-scoresheet.md 评分记录表 知识运营 WS-12 已交付 Sprint-2 评分预置
overview/01-architecture.mmd 全链路架构图 AI 知识库 WS-13 已交付 Mermaid Flowchart
overview/02-indexing-pipeline.mmd 文档入库时序图 AI 知识库 WS-13 已交付 Mermaid Sequence
overview/03-query-pipeline.mmd 在线检索时序图 AI 知识库 WS-13 已交付 Mermaid Sequence
overview/04-graphrag-indexing.mmd GraphRAG 索引时序图 AI 知识库 WS-13 已交付 light + general
overview/boundaries.md 11 个 RAG 阶段边界定义 AI 知识库 WS-13 已交付 输入/输出/接口契约
overview/DocMap.md Sprint-2 41 篇文档大纲 AI 知识库 WS-13 已交付
overview/source-inventory.md 源码盘点 + 模块依赖图 Python 工程师 WS-14 已交付 WS-14 评论
pipeline/01-loader-parser-chunking.md Loader / Parser / Chunking Python 工程师 WS-15 已交付 待 S2-T7 评分 WS-15 评论
pipeline/02-embedding.md Embedding 模型与向量生成 Python 工程师 WS-16 已交付 待 S2-T7 评分 WS-16 评论
pipeline/03-vdb-and-retrieval.md VDBES与混合检索 Python 工程师 WS-17 已交付 待 S2-T7 评分 WS-17 评论
pipeline/04-graphrag.md GraphRAG 实现详解 Python 工程师 WS-18 占位 上一次执行 API Error待重启
pipeline/05-reranking-prompt-llm.md Rerank / Prompt / LLM / 后处理 Python 工程师 WS-19 已交付 待 S2-T7 评分 WS-19 评论
end-to-end/README.md E2E 调用链路与时序图 AI 知识库 WS-20 占位 阻塞中:依赖 S2-T1~T5 全部交付
evolution/architecture-refactor-suggestions.md 架构改造建议11 条) AI 知识库 WS-22 已交付 + 终审 96 / 100 review/S3-T1-final-review.md
evolution/future-extensions-roadmap.md 后续迭代功能6 个方向) AI 知识库 WS-23 已交付 + 终审 95 / 100 review/S3-T2-final-review.md
evolution/capability-map.mmd 能力地图 AI 知识库 WS-23 已交付 Mermaid配合 S3-T2
review/S3-T1-final-review.md S3-T1 终审报告 知识运营 WS-24 已交付
review/S3-T2-final-review.md S3-T2 终审报告 知识运营 WS-24 已交付
review/S2-T7-pending.md Sprint-2 评审收口 知识运营 WS-21 未启动 上一次 API Error待重启
review/README.md 评审历史索引 知识运营 WS-24 已交付
_indexes/glossary.md 关键术语表 知识运营 WS-24 已交付
_indexes/file-index.md 源码 → 文档反查 知识运营 WS-24 已交付
_indexes/chart-index.md Mermaid 图集中清单 知识运营 WS-24 已交付
_release/release-manifest-v1.0-RC1.md 发布候选清单 知识运营 WS-24 已交付 含 v1.0 升版门槛
_release/versioning-convention.md 版本号约定 知识运营 WS-24 已交付
_release/ops-and-freshness-plan.md 运营与保鲜计划 知识运营 WS-24 已交付

3. 状态汇总

状态 数量 占比
已交付(终审通过 / 待 Sprint 评审) 28 84.8%
占位 / 阻塞 / 待重启 5 15.2%
合计 33 100%

v1.0-RC1 阶段:核心 RAG 链路文档_meta + overview + S3 演进已完整成型4 篇 Sprint-2 文档S2-T1/T2/T3/T5已交付待 Sprint-2 收口评审([S2-T7]打分2 篇S2-T4 GraphRAG 与 S2-T6 E2E等待重启。完整 v1.0 在 S2-T7 通过后发布。

4. 评审决议汇总

文档 维度 准确性 完整性 时效性 可读性 可执行性 总分 决议
S3-T1 架构改造建议 终审(知识运营) 25 25 13 14 19 96 PASS
S3-T2 后续迭代路线图 终审(知识运营) 24 25 13 15 18 95 PASS
S1-T1 治理资产 自评 + 同行 25 25 14 14 19 97 已交付
S1-T2 架构图与目录大纲 自评 24 24 14 14 18 94 已交付
S1-T3 源码盘点 自评 25 24 14 14 19 96 已交付
S2-T1 ~ T5 各深度文档 待 S2-T7 终审 等待评分

说明S1 系列文档自评分为知识运营在本次 v1.0-RC1 整理过程中的"快速复核分",仅供 PM 排序参考,正式分数以 [S2-T7] 收口评审或后续保鲜窗口为准。S2 各篇深度文档需在 [S2-T7] 评审通过后,由 [@知识运营与治理专家] 在评分卡上正式打分;当前阶段以"已交付"作为质量门槛。

5. 与子任务 Issue 的双向链接

文档 关联 Issue 标识符
_meta/* b1ead19b WS-12 / S1-T1
overview/01-04, boundaries, DocMap 21b40027 WS-13 / S1-T2
overview/source-inventory.md 264529aa WS-14 / S1-T3
pipeline/01-loader-parser-chunking.md 1b2dde64 WS-15 / S2-T1
pipeline/02-embedding.md 7a8cd047 WS-16 / S2-T2
pipeline/03-vdb-and-retrieval.md 53783731 WS-17 / S2-T3
pipeline/04-graphrag.md (占位) 16bdb196 WS-18 / S2-T4
pipeline/05-reranking-prompt-llm.md eef8ed99 WS-19 / S2-T5
end-to-end/README.md (占位) a3deeaa1 WS-20 / S2-T6
review/S2-T7-pending.md 41f2482b WS-21 / S2-T7
evolution/architecture-refactor-suggestions.md bc97a22c WS-22 / S3-T1
evolution/future-extensions-roadmap.md, capability-map.mmd 0de2c8f6 WS-23 / S3-T2
全集(本任务) a07f108d WS-24 / S3-T3

MemoryBear RAG Docs · INDEX.md · v1.0-RC1 · 2026-05-08