DEV_DOC MODULE KNOWLEDGE BASE
OVERVIEW
项目架构文档的中枢神经。v0 Architecture/ 已删除,git 是唯一备份。
STRUCTURE(v1.0)
dev_doc/
├── Refactoring/ ← 架构裁定权威(最高优先级)
│ ├── PCR_Master_Blueprint.md ← v1.0 终极 spec(What / Where / Why)
│ ├── PCR_Discussion_Log.md ← 设计推理过程
│ └── ...
│
├── Architecture_v2/ ← 实现层文档(HOW)
│ ├── 00_Index.md ← 全文索引 + 阅读路径
│ ├── 01_Foundation/ ← types/ frames/ monad/ contracts/
│ ├── 02_Physical_World/ ← environment/ + plant/
│ ├── 03_Avionics_and_Bus/ ← avionics/ + bus/
│ ├── 04_FCC/ ← fcc/
│ ├── 05_Dynamics_Core/ ← dynamics_core/(普适内核)
│ ├── 06_Simulation/ ← simulation/(跨域绑定唯一合法层)
│ ├── 07_Runtime/ ← runtime/(生命周期)
│ ├── 08_Cross_Cutting/ ← 跨子域 pattern + 路线图
│ └── 09_Vision/
│
├── Tacit_Knowledge/ ← TDD 策略 + 算法集成经验
├── Theoretical_Reference/ ← 物理/数学参考资料
└── WhatAboutOurFuture/ ← 远期愿景草稿> 旧 Architecture/ 目录已删除(v0 文档与 v1.0 严重偏离)。需要追溯旧内容请用 git log / git show <commit>:dev_doc/Architecture/...。
信息层级
| 优先级 | 文档 | 当问什么时查 |
|---|---|---|
| 1 | Refactoring/PCR_Master_Blueprint.md | 任何架构判定、目录归属、迁移计划 |
| 2 | Architecture_v2/<topic>.md | 具体组件的 API/算法/契约/反模式 |
| 3 | Refactoring/PCR_Discussion_Log.md | "为什么做这个裁定"的原始讨论 |
| 4 | 各子目录 AGENTS.md | 子模块本地 hint(可能滞后) |
冲突原则:发现 v2 doc 与 Blueprint 矛盾 → 以 Blueprint 为准 + 修 v2 doc。发现 v2 doc 与子目录 AGENTS.md 矛盾 → 以 v2 doc 为准。
CONVENTIONS FOR AI AGENTS
- 写新文档前:先查
Architecture_v2/00_Index.md,看主题是否已有 owner doc。不要重复。 - 更新 roadmap:里程碑变化时更新
Architecture_v2/08_Cross_Cutting/Implementation_Roadmap.md(不再是Architecture/00_Implementation_Roadmap.md,那个已被删除)。 - C-Distillation 意识:所有 C++ Monad / 模板是脚手架,终态 MISRA C。每个 v2 doc 末尾有 "C-Distillation 路径" 节,对齐之。
- 简洁优先:避免堆 fluff。工程化、批判性、可执行。Mermaid / 表格优于长段落。
- 路径写法:
src/<lib>/<path>全路径,避免和 Blueprint 库名混淆。 - 引用而非复制:Blueprint 已有的论证用
→ Blueprint §X.X,不在 v2 doc 里重复。
REFACTORING CONTEXT(必读)
项目正从 v0 架构迁移到 PCR Master Blueprint v1.0:
- Plant(物理真值 + 资产)+ Controller(FCC 软件)+ Runner(部署/信道)三分
- 13 库依赖图:
types/frames/monad → contracts → environment/plant/bus/avionics/fcc/dynamics_core → simulation → runtime - Dual-Layer RWS:WorldRWS(全局编排)+ BodyRWS(per-body 演化)
- 迁移分四波(Wave 0 目录正骨 → Wave 1 plant physics → Wave 2 device + avionics → Wave 3 FCC 全闭环)
详见 Refactoring/PCR_Master_Blueprint.md §1–6 与 Architecture_v2/08_Cross_Cutting/Implementation_Roadmap.md。