为编码智能体写一份项目说明文件

这条技能适合你吗？

开始之前

• 在干净检出下能构建和测试项目的命令。
• 对哪些目录和操作属于禁区已经达成一致。

步骤

检查点没过，就不要往下走。

1. 原样写下命令

   列出确切的安装、构建、测试和代码检查命令，从一次成功的运行里直接复制。

   检查点 每条命令粘到全新终端里都能成功。

2. 说明边界

   指明不能编辑的目录、需要审批的操作（依赖、数据库迁移、联网），以及“绝不把密钥写进文件”这一条。

   检查点 每条边界都写成具体规则，而不是偏好。

3. 用示例说明约定

   指定一个现有文件，作为风格、命名和测试的范本。

   检查点 每条约定都指向仓库里真实存在的文件。

4. 定义完成标准

   列出必须通过的检查，以及智能体在结束时应当汇报什么。

   检查点 复核者看完汇报就能判断任务是否完成。

5. 跑一个试用任务

   只给智能体这份文件和一个小而真实的任务，记下它每一处做错的地方。

   检查点 每个错误要么促成一次文件修改，要么被判定与文件无关。

可能出问题的地方

• 安全 这份文件会被工具和人读取。绝不要放入令牌、内部主机名或客户数据。
• 准确性 过时的命令比没有命令更糟。构建方式一变，就要重跑这些命令。

相关条目

• FM-08 让编码智能体去实现你先写好的测试
• FM-09 用只读的智能体做代码评审

修订记录