mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-11-01 14:57:38 +00:00
a402bfd777
## 为什么删
执行计划在实施完结后**会变成误导性读物**：它记录的是"当时打算做什么"，
而读者会读成"现在是什么"。
这在本仓已经造成真实误读 —— `prod-migration-checklist.md` 写着
「状态：HologramAgent 已停机」，那是一次性迁移（2026-10-04）当场的状态，
但照着读会以为服务现在还停着。
## 删了 7 份，删前提取三类内容
| 删掉的文档 | 行数 |
|---|---|
| `memory-restructure-plan.md` | 168 |
| `memory-blockflow-repair-plan.md` | 450 |
| `memory-usability-plan.md` | 309 |
| `scene-memory-fix-plan.md` | 271 |
| `toolcall-parallel-execution-plan.md` | 578 |
| `prod-migration-checklist.md` | 157 |
| `entities-retirement-plan.md` | 118 |
**提取去向**：
1. **教训 → 新建 `engineering-lessons.md`**
这些是它们唯一还有长期价值的部分。汇总成一篇，并按形态归类：
- 判据类（5 条）：结构判据不能替代质量判据 / 测「接线之后」≠测「有没有接线」/
验证通过≠架构正确 / fixture 照臆测字段编 / 先改代码再写测试
- 接线类（3 条）：机制≠接线 / 依赖图是唯一保证顺序的地方 / 单数改了复数漏了
- 权限与生命周期（3 条）：「接上了」有三层 / 以调用方名字为键的表要清理 /
提权口子：让调用方声明自己是谁
- 流程类（3 条）：长任务纪律 / 数字要现场取 / 计划不进仓库
文末点出它们共同的形态：**某种"看起来对了"的信号与"真的对了"之间存在缺口。**
2. **实测数据 → 并入 `toolcall-contract-and-sequence-design.md` 附录 A**
那是新旧内核的对比压测（288 条输入 × 两版），核心结论值得留：
```
场景 旧版中位/工具数 新版中位/工具数
slowbatch8 0.220s / 0 个 0.409s / 8 个
```
★ **旧版"更快"是假的** —— 它的 `openai.lua` 缺 `stream_index` 透传，
多个分片并到槽 0 ⇒ 每个工具报参数错误而一个都没真跑。
这是「只看耗时会被骗」的典型。
另附 stage 锁告警的完整归因（不是内核缺陷，成因在插件进程侧运行时）。
3. **未完成的项 → `future-plan.md` §六**
尤其 `entities-retirement-plan` 那条：方案是"三表全退"，但 2026-10-31
实测生产库 `entities 1292 / relations 978 / sentences 66` 行**仍在用**。
这个事实不能随文档一起消失。
## 保留两份（它们不是计划，是依据）
- `legacy-table-retirement.md` —— 被 **4 处生产代码注释**引用（`graph.go` ×2、
`commit_blocks_test.go`、`probe_prod_test.go`），是退役判断的依据
- `interrupt-subsystem-split-plan.md` —— 探测事实被 `interrupt_invariant_test.go`
引用；拆分本身确实未实施
## 索引重写
`docs/zh/README.md` 现在是「四类文档」的规则说明：
| 类型 | 回答什么 | 命名 |
|---|---|---|
| 设计文档 | 为什么这样设计 | `*-design.md` |
| 操作手册 | 怎么做 | `*-runbook.md` |
| 教训 | 踩过什么坑 | `engineering-lessons.md` |
| 未做登记 | 还剩什么没做 | `future-plan.md` |
并明确写「**不放执行计划**」及例外条件。
## 顺带修掉的引用
删除后 4 处引用指向不存在的文件：
- `deploy-runbook.md` → 改指 `toolcall-contract-and-sequence-design.md`
- SDK 仓 `guide/stream-tool-call-index.md` / `guide/parallel-tool-declaration.md`
→ 同样改指（这两个在 SDK 仓，随后单独提交）
## 验证
- docs/zh 27 篇，索引里列的全部存在、无遗漏
- 全仓无指向已删文档的引用（代码 + 文档）
- 代码块全部配平
- go build 通过
docs/zh 文档索引
建立于 2026-10-31。目的：让读者知道该信哪一篇。
此前本目录混着三种时态 —— 当时实测、历史推演、执行计划 —— 外观完全相同。 曾有文档写着「
main.go仍走串行代码」而实际早已接完（滞后一整轮发布）。
一、本目录只放四类文档
| 类型 | 回答什么问题 | 有长期价值 | 命名 |
|---|---|---|---|
| 设计文档 | 为什么这样设计 | ✅ | *-design.md |
| 操作手册 | 怎么做 | ✅ | *-runbook.md |
| 教训 | 踩过什么坑 | ✅ | engineering-lessons.md |
| 未做登记 | 还剩什么没做 | ✅ | future-plan.md |
❌ 不放：执行计划
执行计划（*-plan.md / *-checklist.md）会随实施完结变成误导性读物 ——
它记录"当时打算做什么"，而读者会读成"现在是什么"。
2026-10-31 删除了 9 份已完结的计划，删前把两类内容提出来：
| 内容 | 去向 |
|---|---|
| 决策与教训 | engineering-lessons.md |
| 未完成的项 | future-plan.md |
| 实测数据 | 并入对应设计文档（如压测数据进 toolcall-contract-and-sequence-design.md 附录 A） |
唯一例外：legacy-table-retirement.md 与 interrupt-subsystem-split-plan.md 保留 ——
前者被 4 处生产代码注释当作退役依据引用，后者记录的探测事实仍被判据引用。
它们不是"执行计划"，是依据。
二、怎么判断一篇文档的可信度
每篇首部都有状态行，取值只允许这四种：
| 状态 | 含义 | 能当事实用吗 |
|---|---|---|
| 已实现并部署 | 描述与代码一致，关键处给了取数命令 | ✅ 直接信 |
| 部分实现 | 先说清哪部分生效（附实测调用点） | ⚠️ 只信标了"生效"的 |
| 设计 / 未实现 | 是方案，代码里可能没有 | ❌ 只能当设计意图 |
| 归档说明 | 历史记录，故意保留当时写法 | ❌ 不要改、也不要信 |
判据名的可信度规则
文档里的 TestXxx 不保证现在还存在：
- 已实现并部署类文档里的 → 应当存在。找不到就是缺陷
- 设计 / 未实现类文档里的 → 是规划名，可能从未实现
- 归档说明类文档里的 → 记录当时事实，可能已改名或删除
真实案例：BootCtx 改名 KernelState 后，
TestBootCtxCloseAllIsReverseOrder → TestKernelStateCloseAllIsReverseOrder，
文档没跟上。
核对命令：
for n in $(grep -rhoE '`Test[A-Z][A-Za-z0-9_]+`' docs/zh/*.md | tr -d '`' | sort -u); do
grep -rq "func $n(" --include="*_test.go" internal cmd 2>/dev/null || echo "缺失: $n"
done
有缺失不一定是缺陷，先看它出在哪类文档里。
当前基线（2026-10-31）：27 条缺失，全部已知：
| 篇数 | 文档 | 性质 |
|---|---|---|
| 18 | commondev-*.md |
「设计 · 未实现」类，判据名是规划名 |
| 7 | kernel-modularization-design.md |
§2.7.3 的对照表左栏（有意的历史记录） |
| 2 | multimodal-space.md |
视频能力未纳入契约，判据为规划名 |
⇒ 在「已实现」类文档正文里找不到，才是缺陷。
三、文档清单
3.1 设计文档 —— 可以直接当事实
| 文档 | 内容 |
|---|---|
kernel-modularization-design.md |
装配架构权威：依赖声明、BFS 分层、Group 0、实例化粒度 |
kernel-secret-firewall-design.md |
安全防火墙（部分实现，见文首接线状态表） |
input-scheduler-design.md |
两类别输入 + L1–L4 中断 + 可抢占 |
resident-subagent-design.md |
驻留子：轻量内核、两级记忆、父子 L3/L4 |
toolcall-contract-and-sequence-design.md |
工具调用契约（附录 A 是压测数据） |
commondev-design.md |
主管式多仓库开发流水线（设计 · 未实现） |
commondev-agent-runtime-design.md |
commondev 运行时与内核接入 |
context-overflow-l4-design.md |
上下文超页 L4（归档，术语过时） |
triple-distill-llm-design.md |
三元组蒸馏（已实现并部分否决） |
3.2 操作手册
ci-cd-runbook.md— CI/CDdeploy-runbook.md— 部署site-infra-runbook.md— 站点基础设施
3.3 参考 / 实测报告
| 文档 | 内容 |
|---|---|
engineering-lessons.md |
踩过的坑与共同形态（推荐先读） |
kernel-performance.md |
性能实测基线 |
production-recall-validation.md |
生产召回验证（「探针 PASS 但结论是假的」） |
recall-as-association.md |
召回作为关联 |
recall-capability-tiers.md |
召回能力分层（含 2 个未补缺口） |
multimodal-space.md |
多模态向量空间 |
vector-provider-decision.md |
向量 provider 选型（已定） |
abstention-criterion.md |
弃答判据 |
triple-extract-attention.md |
三元组抽取与注意力 |
3.4 依据类（不是计划，是退役/拆分的判断依据）
| 文档 | 为什么保留 |
|---|---|
legacy-table-retirement.md |
被 4 处生产代码注释引用；剩余读方清单在 §八/§十二 |
interrupt-subsystem-split-plan.md |
探测事实被判据引用；拆分本身未实施 |
3.5 归档说明 —— 历史记录，不要改也不要信
live-run-evidence-2026-10-04.md— 某次实跑证据快照legacy-issues.md— 遗留问题清单（部分条目已过时）
归档文档里的旧工具名（
memory_recall等）故意不改 —— 它们是证据快照， 改了就无法判断"这条结论是在哪个版本上得出的"。
3.6 单一登记处
| 文档 | 内容 |
|---|---|
future-plan.md |
全仓唯一的「尚未实现 / 已知缺口」登记处 |
四、写文档的三条纪律
-
数字类断言必须给取数命令（如模块数用
go run ./cmd/homed-depgraph -print），不要凭记忆。 本文档集写错过一次（17 模块 vs 实际 20）。 -
区分「机制存在」与「接线生效」。本项目头号缺陷形态是 机制写对了、判据全绿、生产里零调用方。描述能力时写实测的生产调用点。
-
判据要能红。写判据时先问：把对应实现删掉，这条判据会红吗？ 本仓踩过两次：
security_toolgate_test.go手动调SetSecurity把缺失的接线补上了；retention_test.go手写合规文件名， 从没跑过真实产物。两者都永远绿。