本仓库为 AgentiX-E/cortex(TypeScript 智能体记忆层, Node + 浏览器双端)的内部中文文档与设计阶段的证据。
| # | 文档 | 回答什么 | 谁该读 |
|---|---|---|---|
| 01 | 产品白皮书 | 这是什么、给谁、凭什么是它;竞品与文献调研覆盖矩阵;功能清单与实现状态 | 所有人,先读这份 |
| 02 | 技术设计方案 | 怎么造:包布局、抽象层、选型、分诊与读写边界、提示词接口、供应商契约 | 实现者 |
| 03 | 项目执行推进计划 | 按什么顺序做、做到什么算过:启动顺序、里程碑、覆盖率、评测协议、指标与消融 | 实现者与验收者 |
| 04 | 执行追踪报告 | 实际做了什么、证据是什么、和计划差在哪;缺陷登记簿、证据登记、未取证缺口 | 决策者,每轮更新 |
建议顺序:01 → 04 → 03 → 02。先知道它是什么、现在在哪,再知道要做什么、怎么做。
四份文档的分工是排他的:01 不写实现细节,02 不写进度,03 不写历史,04 不写未来。 任何跨文档重复的结论以 01 为准;任何与实测冲突的表述以 04 为准。
| 目录 | 内容 |
|---|---|
poc/ |
7 个可复跑实验(npm run all)。每个都写明"能证明什么 / 不能证明什么" |
poc/results/ |
每个实验的原始数(.json)与文档引用的表(.md) |
evidence/ |
94 篇验收判决、分析脚本、run id、日志。是记录不是文档,不需要读 |
[POC-n] 标记的每个数字都能在 poc/results/ 找到同名键;[实测] 标记的每个数字都能在
evidence/longmemeval/run-ids/ 找到 run id。
两个实验需要本机没有的东西,因此写成可派发的工作流(poc-platform-probes.yml):
Safari 需要 macOS(safaridriver),Hub 语料需要外网。结果提交到 ci-results 分支,
主分支只保留被引用的那几份(如 poc/results/p01-safari-webdriver.json)。
仓库曾是 private,Actions 作业因此不启动;设为 public 后两条链一次跑通 —— ci-smoke.yml
保留下来,因为它正是用来区分"没有 runner"与"工作流写错了"的那件仪器。
- 文档使用中文;代码注释、外部文档、commit message、POC 脚本注释一律英文。
- 所有改动以 Lambertyan 名义提交。
- API key / PAT 不得出现在任何文件里,只通过环境变量注入。
- 记录(
evidence/)只读:发现记录与文档冲突时,改文档,不改记录。
文档的完整性不靠人工纪律,靠机械校验:
tools/check-analysis-record.sh # 结构与自测
tools/check-analysis-record.sh --sources <dir> # 追加数值保真(需英文原文目录)| 检查 | 捕获的失效 | 为什么数值比对查不到 |
|---|---|---|
| 守卫自测 | 某项检查的模式已静默失配 | 不适用(元检查) |
| 检查器回归套件 | 容差被放宽或无差别拒绝 | 不适用(元检查) |
| 结构完整性 | 空文档、残留英文、冻结引用被本地化 | 未翻译的文档与源文件逐字节相同 |
| 数值保真 | 数值被篡改、丢弃、改精度或改符号 | 反过来说:它抓不到"照抄原文" |
「未翻译」这一项依赖 CJK 判定:一个从未翻译的文档与源文件逐字节相同,数值比对会以构造性
方式通过。因此中文字符类写作 Unicode 属性 \p{Han},而不是范围 [一-鿿] —— 后者在
en_US.UTF-8 下是排序范围,grep 会报 Invalid collation character 且一个字符都匹配
不到,从而让每个英文文档都通过。
守卫同时覆盖两处:evidence/longmemeval/(记录,需数值保真)与 docs/(四份文档,需结构
完整)。四份文档不参与"翻译保真"比对,因为它们不再是译文的逐句复刻,而是重新组织的论证。
2026-10 之前本仓库有 15 份文档(01–15)。为满足"只保留四份"的要求,其中 06–15 的内容被抽取
重组进四份文档,05 的分析记录整体移入 evidence/longmemeval/。旧文档全文仍可从 git 取回:
git show 020d9eb:docs/07-sota-roadmap.md # 旧 SOTA 推进计划(3900 行)
git show 020d9eb:docs/09-progress-and-delivery-report.md # 旧进度追踪(19500 行)
git show 020d9eb:docs/06-code-docs-consistency-audit.md # 旧一致性审计| 旧文档 | 去向 |
|---|---|
| 01 竞品分析与白皮书 | → docs/01 §1–§2、§5 |
| 02 技术设计与实现 | → docs/02 §1–§13 |
| 03 实现推进与验收计划 | → docs/03 §1–§12 |
| 04 知识字典 | → docs/01 附录 A(仅保留本文出现过的词) |
| 05 LongMemEval-S 分析记录 | → evidence/longmemeval/(原样迁移) |
| 06 代码与文档一致性审计 | → docs/04 §4.5 |
| 07 SOTA 推进计划 | → docs/03 §2/§7/§8、docs/04 §2 |
| 08 阅读器判断再研究 | → docs/01 §7 第 6 条、docs/04 §2 |
| 09 进度追踪报告 | → docs/04 §2–§5(判决原文见 evidence/) |
| 10 A2 收口结果 | → docs/04 §1.3、§5 第 4 条 |
| 11 供应商限流审计 | → docs/02 §11 |
| 12 浏览器与联邦设计 | → docs/02 §3/§5/§6 |
| 13 竞品与文献综述 | → docs/01 §3(覆盖矩阵) |
| 14 证据登记与 POC | → docs/04 §6/§7 |
| 15 指标与消融计划 | → docs/03 §6/§7 |