docs(rag): add MemoryBear RAG implementation docs v1.0
Some checks failed
Sync to Gitee / sync (push) Has been cancelled
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>
This commit is contained in:
33
docs/rag/_meta/README.md
Normal file
33
docs/rag/_meta/README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: "_meta/ — 治理资产(待补全)"
|
||||
status: 占位(待回填)
|
||||
source-issue: WS-12 / [S1-T1]
|
||||
last-reviewed-at: 2026-05-09
|
||||
---
|
||||
|
||||
# _meta/ — 治理资产(待回填)
|
||||
|
||||
本目录用于存放 RAG 文档项目的治理资产(统一模板、评分卡、SOP、命名规范等),由 [WS-12 / S1-T1] 任务交付。
|
||||
|
||||
## 状态
|
||||
|
||||
[S1-T1] 任务的交付物在 [WS-12 评论 `93ea1f50`](mention://issue/b1ead19b-920b-494b-95b5-ab2057d4dd14) 中已声明完成(写入 agent 工作分支),但相关文件未持久化到 main 分支与本仓库 `docs/rag/` 目录树。本次 v1.0 文档全集提交时,按 [WS-26](mention://issue/5c12d0a3-89ea-4e92-adb4-d98eddfa3eab) 用户指示将仓库迁移到 `git.poflow.cn:30010/adai/MemoryBear.git`,本目录暂作占位,后续回填。
|
||||
|
||||
## 应有内容(按 [`../INDEX.md`](../INDEX.md) §2 责任矩阵)
|
||||
|
||||
| 文件 | 内容 | 责任人 |
|
||||
|---|---|---|
|
||||
| `README.md` | 治理体系总览,含 8 环节与代码目录映射速查表 | 知识运营与治理专家 |
|
||||
| `document-template.md` | 统一文档模板(覆盖 8 个 RAG 环节,9 大章节结构) | 同上 |
|
||||
| `scoring-rubric.md` | 质量评分卡(5 维度 / 100 分制 / 通过线 80) | 同上 |
|
||||
| `review-sop.md` | 审校流程 SOP(自检 → 同行 → 终审) | 同上 |
|
||||
| `directory-naming-spec.md` | 目录与命名规范(frontmatter 规范) | 同上 |
|
||||
| `rubric-scoresheet.md` | 评分记录表模板(Sprint-2 评分预置) | 同上 |
|
||||
|
||||
## 回填路径建议
|
||||
|
||||
1. **首选**:从 [@知识运营与治理专家](mention://agent/7e9211a6-41eb-429e-9dd1-4c7afcffd412) 的本地工作目录恢复并提交。
|
||||
2. **次选**:基于 [WS-12 评论 `93ea1f50`](mention://issue/b1ead19b-920b-494b-95b5-ab2057d4dd14) 中描述的设计决策与各文件大纲,由知识运营重新生成(约 0.5–1 个工作日)。
|
||||
3. **快速兜底**:参考 [`../_indexes/glossary.md`](../_indexes/glossary.md) 与 [`../_release/versioning-convention.md`](../_release/versioning-convention.md) 中已沉淀的部分约束(如版本号约定、frontmatter 字段),先建立最小可用版本。
|
||||
|
||||
完整回填后,请同步更新 [`../INDEX.md`](../INDEX.md) §3 状态汇总(占位计数 −5 → 已交付 +5)。
|
||||
Reference in New Issue
Block a user