Agent Notes:把「为什么」写成一级资产

dsh 最独特的机制:每个非平凡变更强制附决策笔记,生命周期与分类全部路径编码,含中英双语。

工程实践 导读对象:.agents/notes/README.md 阅读原文 ↗ ← 全部导读

如果说 dsh 的代码架构值得学,它的决策记录机制更值得抄。官方规则一句话:每个非平凡变更必须在同一个 PR/变更中新增或更新至少一篇 Agent Note。「非平凡」的判定:改变了行为、架构、跨文件契约、流程工具、测试策略、磁盘/线上/配置格式……纯机械改动才豁免。

笔记记录什么

代码和文档装不下的部分:决策的 why放弃了什么(alternatives)、后果、以及「什么情况下应该重新引入被否决的方案」。一篇笔记永远不会被改写成另一个决策——要推翻就新写一篇并互相链接。

路径即元数据

每篇笔记的路径自带三段信息:

{lifecycle}/{class}/yyyy-mm-dd-topic-title.md

生命周期(顶层目录,状态变化 = 移动目录):

分类(二级目录,封闭集合):feature / bug-fix / simplification / architecture / process / testing。注意没有 refactor——被刻意并入 simplification(判别式:可观察行为是否变化)。

日期是主题首次提出的时间(按 git 历史定)。

一致性是机械可校验的

为什么值得抄

传统项目的 ADR(Architecture Decision Record)往往「写完即腐」:决策变了没人更新,链接烂掉,最后没人信。dsh 的解法是把笔记编入强制的变更流程并用 CI 校验器包围——文档不是代码的附庸,而是和代码同权重的交付物。本站「设计笔记」板块就是这 907 篇笔记的中文导览。

官方还有一篇 no-index 笔记解释为什么不建总索引:活跃生命周期目录树本身就是工作清单。