文档索引
状态:维护中 · 最后更新 2026-11-06
本目录是正文仓库,根目录 README 只做门面。按"读它的目的"选:
| 我想…… | 读这个 |
|---|---|
| 知道这个项目到底主张什么、反驳什么 | vision.md |
| 搞清四层怎么分、谁管什么 | architecture.md |
| 看层与层之间传什么信号 | interfaces.md |
| 知道怎么证明"有效" | evaluation.md |
| 确认情绪不会影响安全 | safety.md |
| 知道下一步做什么、怎么接活 | roadmap.md |
| 跑 v0.2 的实时栈、看它的边界 | testbed.md |
| 看 L4 服务怎么起、怎么降级 | ../server/README.md |
| 查 L1/L2/抢占/效价这些词 | glossary.md |
| 看某个决策为什么这么定 | adr/ |
| 读长文观点(假说) | blog/ |
机器可校验的部分在别处:
contracts/:层间信号的 JSON Schema 与样例evals/:基线配置、指标定义、复现日志格式
文档状态约定
每份文档开头必须标状态,只有三种:
| 状态 | 含义 | 能不能被引用 |
|---|---|---|
定稿 | 已经过 RFC 讨论,改动需走 ADR | 可以 |
草案 | 有明确主张,但字段/数值可能变 | 可以,注明版本 |
占位 | 只有结构,内容是空的 | 不能,当它不存在 |
当前全部为 草案——因为 v0.1 还没有被实现验证过。这不是偷懒,是如实标注。
维护规则
- 一份文档只负责一件事。路线图不写进架构文档,基线不写进 README。
- 修改架构或契约:先 Issue(架构 RFC 模板)→ 达成方向 → 再改文档 → 补 ADR。
- 数字(阈值、时间窗、采样率)没有实测依据就写
TBD,并写清谁来定。 宁可显眼地空着,也不要填一个看起来很专业的假数。 - 图必须带源文件。
assets/architecture-long.png的源是同目录的.mmd, 改图先改源、再重出 PNG,不要只改 PNG。 - 文档里的跨文件引用用相对链接(
../),不要用绝对 URL——仓库改名会全断。 - 文档同步是强制的,不是自觉:改了代码就要在同一次提交里改对应文档; 映射表见 AGENTS.md 第 4 节,CI 的
doc-syncjob 会拦。 确实不需要改文档时,在提交信息里写Docs-Sync: skip —— <具体理由>。
待补清单
- [ ]
assets/architecture-realtime.png:L1–L2 实时层拆分图(P1) - [ ]
assets/architecture-cognitive.png:L3–L4 认知层拆分图(P1) - [x]
adr/:架构决策记录(0001 四层隐喻 / 0002 LLM 外部化 / 0003 基线定义) - [ ]
vision.md补"与现有工作的差异"一节,需引用具体文献