From 2c88bbc7e64e1c7734f46e8aae2da1909aed2255 Mon Sep 17 00:00:00 2001 From: Yingjie Wang Date: Sat, 10 Oct 2026 01:50:42 -0400 Subject: [PATCH] Doc: Define authoritative design document hygiene rules --- AGENTS.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 136d20c..24edac4 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -85,6 +85,15 @@ catalog 内部数据保留 `(direction, temperature, amplitude)`，而非 RGB。 性能 benchmark 记录必须保留完整、可复制的命令及原始终端输出，不能只记录汇总耗时或吞吐量；输出中的 build/cache、输入加载、工作线程、处理数量与 fallback 等统计是后续正确归因性能变化的证据。 +## 权威设计文档卫生 + +- 仓库级文档规则应具有跨任务适用性，不夹带单次任务的细节或案例。 +- `nr_spacetime_movie_renderer_design.md` 应简明描述当前确定的架构、物理与数值约定、模块边界、数据流及 ownership；尚未确定的问题须明确标为待验证。 +- 写最终设计，不写 agent 工作过程、对话经过、实现日记或备选方案淘汰史。已排除的临时设想不要改写成长期禁止条款；必要的物理与架构约束仍须保留。 +- 决策依据只保留理解设计所必需的简要理由。实验过程、性能数据及详细对照放到符合仓库卫生要求的独立记录中，设计文档按需引用。 +- 使用说明集中到 `usage.md`；README 保留面向使用者的简介与示例，避免在权威设计文档中重复罗列。 +- 设计变更应改写并整合原有相关章节，删除过时或重复表述，检查跨章节一致性；不要通过不断追加补充段落堆积历史。 + ## 仓库卫生与短期产物 只有对本项目有长期记录价值、且值得进入 public repo 的测试与 benchmark 才纳入 git。