加上你们团队的规矩

同一个要求反复出现在每次对话里,就可以考虑写进项目约定。比如统一金额单位、界面术语,以及改动后必须验证的业务行为。

先保留项目已有约定

NocoBase 应用模板已经提供 AGENTS.md 和开发指引,说明页面、接口、数据库等代码如何组织。先让 AI Agent 阅读现有内容,在合适位置补充团队要求,不要用一份简短的新文件覆盖它。

不同AI Agent读取项目指引的方式可能不同。开始任务时,明确要求它读取相关文件,并用实际结果检查是否遵循;不要只凭文件存在就认定已经生效。

写能执行、能检查的要求

下面是一个团队约定示例,可以根据项目情况调整:

## 订单业务约定

- 页面金额以元显示,保留两位小数;数据库使用整数分保存。
- 界面统一使用“客户”,不混用“买家”和“客户”。
- 订单号必须唯一;客户端和服务端都检查金额不能为负数。
- 修改订单保存逻辑后,验证新增、修改和刷新后的数据。
- 不在日志、示例数据或提交文件中写入密钥和真实客户信息。

「把代码写好」「界面要美观」不容易判断是否遵守。说明沿用哪套组件、使用哪些业务术语、验证什么行为,会更有帮助。

让约定的范围清楚

全项目都适用的要求放在根目录。只针对某一部分的要求,放在对应目录的约定文件中,并说明作用范围。模板的 client/AGENTS.md 和 server/AGENTS.md 就分别描述浏览器与服务端代码的要求。

团队约定不能替代功能需求。“所有金额以整数分保存”可以长期保留;“今天先完成订单列表”属于任务进度,单独记录即可。

用一次小改动验证

补充约定后,让 AI Agent 完成一个小任务,比如在订单详情中显示金额。检查它是否沿用统一术语、是否按约定处理金额,以及是否实际完成要求的验证。

如果没有遵守,先确认它是否读到文件,再看规则有没有歧义。修改约定后重新检查,不需要为了增强措辞堆满“必须”和“禁止”。

约定跟着项目维护

团队改变了业务规则或目录安排,也要更新对应说明。保留原因,让下次接手的人和 AI Agent 知道为什么这样做。

功能如何拆分见做复杂功能,如何检查结果见检查 AI Agent 的产出。