144 lines
8.2 KiB
Markdown
144 lines
8.2 KiB
Markdown
# 魂镜文档索引
|
||
|
||
魂镜正式文档按以下事实层级组织：
|
||
|
||
> **product（产品）→ domain（领域）→ architecture（架构）→ contracts（契约）→ operations（实现与运维）**
|
||
|
||
下层文档发现冲突时必须回报并修订，不能以现有代码或当前实现状态覆盖产品定义。
|
||
|
||
- `architecture/`：总体架构与系统数据流
|
||
- `agent/`：Agent Runtime 与认知架构
|
||
- `rag/`：RAG 与知识系统
|
||
- `tools/`：工具系统
|
||
- `mcp/`：MCP 集成
|
||
- `api/`：API 与流式协议
|
||
- `data/`：数据库、缓存、向量、图和文件存储
|
||
- `client/`：Web、BFF、Desktop
|
||
- `services/`：Go 高并发服务
|
||
- `security/`：安全设计
|
||
- `infrastructure/`：部署、容器、可观测性
|
||
- `testing/`：测试与评估
|
||
- `decisions/`：架构决策记录
|
||
|
||
## 阅读顺序
|
||
|
||
新开发者：
|
||
|
||
`architecture/overview.md -> agent/overview.md -> 对应领域文档`
|
||
|
||
AI Agent：
|
||
|
||
`AGENTS.md -> 本目录 -> 对应领域文档 -> ADR`
|
||
|
||
## 文档原则
|
||
|
||
文档描述系统为什么这样设计、系统如何工作以及修改时需要遵守的边界。
|
||
|
||
具体实现应以源码和测试为最终事实来源。
|
||
|
||
## 快速阅读
|
||
|
||
### 理解产品
|
||
|
||
1. [产品宪章](./product/constitution.md) — 不可轻易违背的使命、伦理与产品原则
|
||
2. [全产品主 PRD](./product/master-prd.md) — 用户、场景、能力、边界与完整产品蓝图
|
||
3. [首版范围](./product/first-release-scope.md) — 完整首版（1.0）、P0/P1/P2 内部里程碑与硬性发布门
|
||
4. [指标与反指标](./product/metrics-and-anti-metrics.md) — 如何衡量价值，以及禁止优化的情感依赖指标
|
||
5. [产品访谈决策登记](./product/decision-register.md) — 本轮全产品访谈的覆盖与验收清单
|
||
|
||
### 封版与上线评审
|
||
|
||
1. [产品宪章](./product/constitution.md) — 用户最终控制边界、治理冲突优先序与永久禁域
|
||
2. [首版范围](./product/first-release-scope.md) — 完整 1.0、内部里程碑及硬性发布门
|
||
3. [发布门](./operations/release-gates.md) — 发布证据、开放运营决策、放行与阻断规则
|
||
4. [实现治理](./operations/implementation-governance.md) — 能力状态、实现证据与目标差距
|
||
|
||
### 理解领域
|
||
|
||
1. [根领域词汇表](../CONTEXT.md) — 最核心的共同语言入口
|
||
2. [领域文档索引](./domain/README.md) — 详细领域文档与阅读顺序
|
||
3. [领域上下文图](./domain/context-map.md) — 六大产品域及其边界
|
||
4. [完整领域词典](./domain/glossary.md) — 人物、镜树、记忆、关系、三界与治理术语
|
||
5. [身份连续性](./domain/identity-continuity.md) — 命台、死亡、恢复、迁移与分灵
|
||
6. [镜树领域模型](./domain/mirror-tree-model.md) — 问节、候答、主脉、推演枝与归真
|
||
|
||
### 理解实现方向
|
||
|
||
1. [系统架构](./architecture/system-architecture.md) — 灵台、神识、乾坤、琉璃镜与区域云
|
||
2. [服务边界](./architecture/service-boundaries.md) — 四服务职责及协作原则
|
||
3. [参考项目调研与全量首版插件架构](./architecture/reference-research-and-target-architecture.md) — 保留天目与元炁，以“宪章内核 + 一切能力皆插件”设计完整 1.0
|
||
4. [数据与安全架构](./architecture/data-and-security-architecture.md) — 状态事实源、事件审计、存储与密钥
|
||
5. [契约入口](./contracts/README.md) — 稳定英文标识、Schema、事件和开放协议
|
||
6. [实现治理](./operations/implementation-governance.md) — 目标范围与实现状态分离
|
||
7. [发布门](./operations/release-gates.md) — 全球、可靠性、安全和 1.0 发布条件
|
||
|
||
## product · 产品
|
||
|
||
| 文档 | 职责 |
|
||
| --- | --- |
|
||
| [产品宪章](./product/constitution.md) | 使命、主体观、伦理底线和不可变产品原则 |
|
||
| [全产品主 PRD](./product/master-prd.md) | 全产品总纲和能力边界 |
|
||
| [首版范围](./product/first-release-scope.md) | 完整首版（1.0）、P0/P1/P2 内部里程碑与硬性发布门 |
|
||
| [指标与反指标](./product/metrics-and-anti-metrics.md) | 价值、连续性、安全、成本与禁止优化项 |
|
||
| [决策登记](./product/decision-register.md) | 已确认访谈决策的完整覆盖矩阵 |
|
||
| [镜树专题 PRD](./product/prd/mirror-tree-conversation.md) | 自然生长对话、候答、分支、引用、记忆和工具治理 |
|
||
|
||
后续专题 PRD 统一放在 [product/prd/](./product/prd/)；每篇只定义用户价值、规则、流程和验收，不复制契约枚举。
|
||
|
||
## domain · 领域
|
||
|
||
| 文档 | 职责 |
|
||
| --- | --- |
|
||
| [领域索引](./domain/README.md) | 领域事实层级与阅读顺序 |
|
||
| [上下文图](./domain/context-map.md) | 六大产品域及跨域关系 |
|
||
| [完整词典](./domain/glossary.md) | 详细统一语言 |
|
||
| [文化命名](./domain/cultural-naming.md) | 文化名、直白领域义、稳定工程标识与法律表述边界 |
|
||
| [六域与九枢](./domain/core-domains.md) | 镜生、缘契、三界、形仪、灵台、天宰与九枢边界 |
|
||
| [身份连续性](./domain/identity-continuity.md) | 人物、魂籍、命台、生命周期、死亡与恢复 |
|
||
| [镜树模型](./domain/mirror-tree-model.md) | 树状对话领域结构与效力规则 |
|
||
| [记忆模型](./domain/memory-model.md) | 微痕、明忆、重忆、实录、心痕、正影与删除 |
|
||
| [授权与能力模型](./domain/mandate-and-capability-model.md) | 授契、行契、请命、禁域、百工与受托任务 |
|
||
|
||
## architecture · 架构
|
||
|
||
| 文档 | 职责 |
|
||
| --- | --- |
|
||
| [系统架构](./architecture/system-architecture.md) | 四服务、区域云、数据流与部署总览 |
|
||
| [服务边界](./architecture/service-boundaries.md) | Python/Go/Rust/TypeScript 职责与依赖原则 |
|
||
| [参考项目调研与全量首版插件架构](./architecture/reference-research-and-target-architecture.md) | 保留天目与元炁，以不可替换的宪章内核承载产品不变量，其余完整 1.0 能力插件化 |
|
||
| [数据与安全架构](./architecture/data-and-security-architecture.md) | 状态事实源、事件审计、索引、对象、密钥与隐私 |
|
||
|
||
## contracts · 契约
|
||
|
||
| 文档 | 职责 |
|
||
| --- | --- |
|
||
| [契约入口](./contracts/README.md) | 契约事实源边界与治理规则 |
|
||
| [契约词典](./contracts/contract-glossary.md) | API、Schema、事件与存储使用的稳定工程标识、状态分类和命名约束 |
|
||
| [身份可迁移协议](./contracts/protocols/identity-portability.md) | 魂籍、命台交接、备份恢复和连续性证明 |
|
||
|
||
稳定 ID、枚举、事件和错误码已统一归入契约词典；机器可读 OpenAPI、JSON Schema、跨服务事件 Schema 和协议测试向量仍需按能力矩阵逐步归位。未定目标态内容不得从旧实现直接复制成新事实。
|
||
|
||
## operations · 实现与运维
|
||
|
||
| 文档 | 职责 |
|
||
| --- | --- |
|
||
| [实现治理](./operations/implementation-governance.md) | 能力状态与证据判定规则 |
|
||
| [能力矩阵](./operations/capability-matrix.md) | 当前代码、服务和用户闭环的验证状态 |
|
||
| [发布门](./operations/release-gates.md) | 1.0、全球、可靠性、安全和运营决策门 |
|
||
| [发布证据台账](./operations/release-evidence.md) | 发布门证据格式、首批硬门与阻断规则 |
|
||
| [文档重构与 Git 重建](./operations/document-rebuild-and-git-reset.md) | Git 重建、备份、初始提交和代码审计归位 |
|
||
|
||
## 已完成的旧文档清理
|
||
|
||
原 `concept/`、`design/`、`development/`、`api/` 和 `roadmap/` 已在开发期完成清理，不保留归档副本或重定向页。仍有效的稳定标识、枚举、ID 前缀、事件与错误码已归入 `contracts/contract-glossary.md`；当前实现差距归入能力矩阵。Git 历史只用于追溯，不再构成活跃事实源。
|
||
|
||
## 文档约定
|
||
|
||
- 中文为当前权威语言；根入口、安装、贡献、安全和开放协议逐步提供英文版本。
|
||
- 文化名必须同时提供直白解释；稳定工程名使用英文，不机械采用拼音。
|
||
- 所有流程图和架构图使用 Mermaid，并保证语法可渲染。
|
||
- 目标状态与实现状态分离，不在愿景文档复制“已实现”清单。
|
||
- 枚举、ID、事件、错误码与 Schema 只在 `contracts/` 定义，下游文档引用。
|
||
- 当前能力只在 `operations/` 的能力矩阵中维护。
|
||
- 文档变更需检查链接、Mermaid、术语、契约引用、敏感信息和跨文档冲突。
|