跳转到内容
GitHub

怎么读规则

  • 硬约束:必须遵守。只有同时满足下面三点才定为硬约束:有可靠出处,或者违反的后果严重且业内公认;写得出检查方法;措辞里没有「尽量」「酌情」这类软话,适用前提写进了规则本身。做不到时停下来说明,不要悄悄绕过。
  • 软指导:默认照做。有理由可以不做,但要写明理由,并引用规则编号,方便评审。
  • 待确认:还没核实的说法或待补的调研,单独列在每个主题的末尾,不当成规则执行。核实之后才转成规则。
项目 含义
编号 如 AGT-013,全站唯一、不复用,可以直接链接到 /topics/agents/#agt-013
检查方式 自动:工具或 CI 能直接判定;半自动:工具找出候选,人来确认;人工:只能靠评审或演练记录确认
适用范围 不标的规则适用于所有项目;标了「Go」「Web 前端」等的只适用于这类项目。同时标了语言和项目类型的(如「Python」+「对外提供服务的后端」),要两者都符合才适用
怎么检查 判断是否做到的具体办法
参考值 没有权威出处的数字,只作起点,按项目调整
来源 规则的出处,每个来源都标了核实日期
另见 相关内容归别的主题管时,跳过去看

项目自己写明的约定优先。准绳是没有约定时的默认值,也是写约定时的参考。

比如幂等的语义只在「16 接口契约与事件」里定,其他主题只引用。这样同一件事不会有两种说法。

每个主题标了复核日期和下次复核日期。变化快的主题(编码 Agent、大模型、前端等)三个月复核一次,其余半年一次。状态是「草稿」的主题还没经过独立复核。

涉及法律、隐私和许可证的内容只是工程上的参考,不构成法律意见。