一致性

流程一致性

对于 AI 来说，如果项目的命名，模块功能调用流程等方面一致性特别好，那么它就不需要花费很多上下文去分析和理解模块的具体实现，从而变相提高模型性能和开发人员开发效率。

文档一致性

  • 文档需要与代码一同更新
  • 历史设计变更放在专门的文档中存储，方便 AI 知道系统的来龙去脉，这样就不会做一些自以为是的优化

文档的结构

  • 从信息角度上说，应该是目标，模块，实现三层
  • 从文档组织角度上说，应该是 AGENTS.md -> 模块文档 -> 实现文档 -> 代码注释
  • 文档之间应该存在引用关系，让 AI 在需要知道信息的时候，明白去哪里查找

注释

  • AI 生成长篇大论的注释，不仅影响消耗，要是没及时清理还会误导 AI。注释应仅说明代码没能表达清楚的内容。冗余的、日志式的记录改动历史、位置标记等，都应该删除。