Files
pebrel/docs/AGENTS.md
T

832 B

Documentation rules

  • docs/ 记录经过核验的当前事实:系统行为、架构地图、协议、操作手册、验收合同和事故复盘的事实部分。
  • 非平凡决策的原因、被否定方案和替代关系写入 architecture/notes/;计划、待办和临时工作记录不作为当前事实文档新增。
  • 事实变化时更新正文;需要表达演进时写明版本、日期或状态,避免无锚点的“以前、现在、不再”。
  • 不手抄可从 schema、类型定义、命令帮助或生成文件直接得到的 API 清单;链接单一权威来源。
  • 每篇文档保持单一职责和可审查长度。测试语料、发布说明和验收材料按各自用途管理,不套用普通事实文档的机械上限。
  • release-notes/ 还必须遵循该目录更具体的 AGENTS.md。