编写与更新知识
先找到已经说明这个主题的文档,写清决定、适用条件,以及后续读者需要的依据。
选择存放位置
| 内容 | 建议位置 |
|---|---|
| 项目用途、主要模块、已实现行为 | 已有 README 或架构说明 |
| 后续修改应遵守的约定 | .trellis/spec/ |
| 调研、备选方案、放弃的做法 | .trellis/research/ |
| 带主题链接和验证结果的会话小结 | .trellis/workspace/<name>/journal-*.md |
README、docs/ 和 doc/ 中的项目文档也参与召回。具体发现规则见来源范围。
一篇简短规范
# 回调幂等
每个回调携带幂等键。重复投递返回第一次的结果。
唯一性检查位于记账事务内。
验证:重复投递测试覆盖相同幂等键的重试。
新规范应从对应目录的 index.md 链接出来,规则范围与所影响的模块对应。维护长期约定时,可以让 Agent 使用 mini-trellis-update-spec。
一篇调研笔记
# 回调重试
决定:transient 失败总共最多尝试四次,包含首次;permanent 失败只尝试一次。
原因:上游服务已经确认幂等处理。
放弃的方案:记账事务前去重会导致对账错误。
依据:链接到服务商文档,以及相关实现或测试。
这是写法示例,策略和来源需要替换成项目实际确认的内容。保留适用条件、放弃的方案和后续纠正,方便再次判断。
一条开发日志
更新主题后,使用 mini-trellis-remember。日志写明修改文件、执行的验证及结果,并链接到规范或调研笔记。日常排版修改按普通文档编辑处理即可。
决定变化后
部分规则变化时,直接修改对应章节。整篇笔记被替换时,在旧笔记顶部保留替代关系:
---
status: superseded
superseded_by: .trellis/research/current-retries.md
---
目标路径相对于仓库根目录。召回会沿有限长度的替代链定位当前笔记,并可显示其摘录。mem read 返回后继路径;需要正文时继续查找该来源。
目标缺失、路径超出文档来源、循环引用和过长替代链会显示关系错误。文件修改时间本身不表示整篇笔记已被替代。
共享前检查
关于已实现行为的说明,应核对当前代码或测试。保留文档原有语言和有用的来源链接。提交到共享仓库前检查 diff,确认密钥、私有对话和项目专属信息的处理方式。