9.3 KiB
Agent Notes
English | 中文
这里存放一类设计文档。Agent Note（agent 决策记录） 记录塑造本代码库的决策或提案：代码和文档无法承载的为什么以及放弃了什么。本文件是入口和契约：Agent Note 存放在哪里、何时需要写一份，以及文件内格式。
布局与命名
每份 Agent Note 有两个维度，都编码在其路径中：{lifecycle}/{class}/yyyy-mm-dd-topic-title.md。
- 生命周期（顶层文件夹）是 Agent Note 的状态，Agent Note 随状态变化在文件夹之间移动：
proposed/：实施前评审的提案；尚未构建（或仅部分构建）。implemented/：决策已交付。文件记录做了什么决定、否决了什么，并与实际交付的内容保持同步：当代码后续移动文件、重命名包（package）或更改键名/默认值时，Agent Note 在同一个变更中同步更新（仅限事实——路径、名称、结构——而非决策本身）。见 implemented/AGENTS.md。rejected/：提案经过讨论后被否决。保留以备查阅，避免同一问题被反复争论。
- 类别（嵌套文件夹）是决策的种类——见下方分类。
文件名中的日期是该主题首次提出的时间（以 git 历史为准）。Agent Note 之间的交叉引用使用相对 Markdown 链接（[topic](../../implemented/architecture/2026-…-….md)），从不使用纯文字或编号，这样既可机械检查，也能在文件夹间移动时保持有效。
目录树就是清单：浏览其生命周期/类别文件夹，或搜索仓库即可。请勿添加集中式 INDEX.md；设计理由见不设索引的 Agent Note。
分类
每份 Agent Note 属于 scripts/agent-note-tree.ts 中封闭集合里的一个路径编码类别；分类门禁拒绝其他文件夹。新增类别需要同时更新规范集合与本节。见分类 Agent Note。
| 类别 | 覆盖范围 |
|---|---|
feature |
面向用户或模型的新功能。 |
bug-fix |
修正缺陷或弥补事故复盘（postmortem）发现的缺口。 |
simplification |
在不增加功能的前提下移除代码、行为或对外表面积。 |
architecture |
关于交付源码的结构性决策：包之间的关系、运行时词汇。 |
process |
代码周边的工具、策略或工作流——门禁、包管理器、vendor 化——不涉及运行时行为。 |
testing |
测试基础设施与策略。 |
architecture 与 process 的界线：architecture 关乎我们交付的源码；process 关乎围绕源码的工具与工作流。（refactor 被有意排除：它与 simplification 重叠，而后者的判别标准「可观察行为是否改变」已经覆盖了它。）
何时需要写一份
每个非平凡变更都必须在同一 PR（Pull Request）中新增或更新至少一份 Agent Note。如果变更修改了行为、架构、跨文件或跨包契约、流程或工具、测试策略、磁盘、协议或配置格式，或者其他维护者可能合理重新审视的决策，就属于非平凡变更。对未来重大工作的提案从 proposed/ 开始；已经做出的决策从 implemented/ 开始。选择与决策匹配的类别文件夹（见分类）。
更新已经拥有该决策的 Agent Note 即可满足规则；不要创建重复记录。只有不涉及行为、契约、结构、流程或理由变化的纯机械性或局部编辑才可豁免。Agent Note 永远不会被编辑为一个不同的决策：用新 Agent Note 取代旧记录，并让两个记录保持互相链接，除非后续依据下方规则完全合并旧记录。编辑 implemented/ Agent Note 以跟踪其现有决策的所在位置是必需的，而非禁止的；见 implemented/AGENTS.md。
被完全取代的 implemented Agent Note 可以合并到当前持有该决策的记录中，并删除原文件。删除前，当前记录必须保存所有独有的决策依据、备选方案、影响、验证契约和明确指出的覆盖缺口；修复所有入站链接；并在同一变更中删除中文对侧文件、一致性记录，以及翻译配对 manifest（元数据清单）中对应的 required 条目。仅部分被取代的记录不符合此条件：保留两个记录并让它们互相链接，同时更新所有仍然适用的事实。合并不得将旧文件改写成与其相反的决策，也不得让 git 历史成为决策依据的唯一副本。
文件格式
每份 Agent Note 遵循统一的文件内格式，由 pnpm run verify-agent-note-format（scripts/verify-agent-note-format.ts，doc-sync（文档同步门禁）的一环）强制执行；该格式的设计动机及其否决的替代方案见统一格式 Agent Note。
头部块
每份 Agent Note 的前三行严格为：
# Agent Note: <title>
Status: <status>
后跟一个空行。Status: 的值有三种形式，且必须与文件所在的生命周期文件夹一致——门禁会交叉检查：
Status: proposedStatus: implementedStatus: rejected — <why, in one line>
状态行不带日期、不带括号补充说明：文件名记录首次提出日期，git 记录其余一切；「以修订形式接受」之类的说明属于正文内容（在陈述决策的地方说明修订）。拒绝原因是唯一带内容的状态，因为读者查阅被否决的 Agent Note 时，结论正是他们要找的。
正文骨架
每份 Agent Note 的正文以 ## Problem 开头：动机，写法上不依赖解决方案即可独立成文。后续内容取决于生命周期；固定章节使用以下规范名称且仅限这些名称，而真正独特的技术章节（包拓扑、协议契约、schema 等）在必需章节之间可自由组织。
proposed/
## Problem
## Proposal
…bespoke sections…
## Alternatives considered
## Acceptance criteria
## Risks
## Proposal 描述拟议的变更，可以合理地使用将来时态——计划、迁移步骤和待解决问题在工作尚未完成时属于此处。## Acceptance criteria 说明什么可观察状态意味着完成。## Risks 涵盖可能出错的事项以及该变更有意放弃的东西。
implemented/
## Problem
## Decision
…bespoke sections…
## Alternatives considered
## Consequences
## Decision 以现在时态描述已交付的现实，整个文件按 implemented/AGENTS.md 的要求与之保持同步。## Consequences 记录权衡的代价与收益。提案阶段的标题在此属于规格用语，门禁会拒绝它们：## Proposal、## Plan、## Migration plan 和 ## Acceptance criteria 不得出现在 implemented Agent Note 中（原因见 slop 检查清单）。## Testing、## Deferred 或 ## Related 章节在陈述现在时态的事实时是允许的。
rejected/
被否决的 Agent Note 是冻结的提案：保留提案时的所有章节（包括 ## Acceptance criteria 或 ## Plan），结论写在 Status: 行上。仅头部块、## Problem 开头、## Proposal 章节以及下方的「曾考虑的替代方案」强制要求适用。
曾考虑的替代方案——必需
每份 Agent Note 都必须包含 ## Alternatives considered 章节：每个真实的替代方案及其落选原因，每个替代方案用一个加粗引导的段落，或对争议较大的替代方案用 ### Why not <X>? 子节。记录决策时不记录它击败了什么，就是在邀请反复争论——正是这些 Agent Note 存在的意义所要防止的。
替代方案是记录下来的，不是凭空编造的。日期早于 2026-07-05 且替代方案无法从记录中重建的 Agent Note，在该章节位置放置以下精确注释，门禁仅对格式规范之前的文件接受此注释：
<!-- agent-note-format: alternatives-not-recorded (pre-format Agent Note) -->
在生命周期之间移动
将文件在生命周期文件夹之间移动意味着在同一个变更中更新 Status: 行并满足目标文件夹的骨架要求——否则门禁会失败。具体而言，proposed/ → implemented/ 将 ## Proposal 改写为现在时态的 ## Decision，将 ## Acceptance criteria 和 ## Risks 折入 ## Consequences（或折入一个现在时态的 ## Testing/## Verification 章节，用于描述现在锁定该行为的内容），并用实际交付的内容替换计划——即 implemented/AGENTS.md 所要求的改写，使之机械化。proposed/ → rejected/ 仅在 Status: 行添加原因并冻结文件。
中文对侧文件
.zh.md 对侧文件按 i18n 契约逐章节镜像其英文兄弟文件的结构；机器检查的头部标记（# Agent Note: 和 Status: 行）保持英文原样不翻译。格式门禁跳过 .zh.md 文件——配对门禁负责它们的一致性。