1. 为什么你的 AI 编码助手总在"瞎猜"?
作为一名长期使用 AI 编码助手的全栈开发者,我经历过无数次这样的场景:Copilot 生成的代码技术上完全正确,但就是不符合项目规范。要么是命名风格不对,要么是文件放错位置,最头疼的是它偶尔会擅自修改不该碰的配置文件。每次都要花大量时间做"代码翻译"——把 AI 的代码改成项目能接受的版本。
直到我在 GitHub 上发现了一个惊人的数据:那些 AI 辅助效率最高的项目,90% 都包含一个特殊的文件——agents.md。这不是普通的文档,而是专门写给 AI 的"岗位说明书"。就像新员工入职时需要培训一样,AI 助手也需要明确知道你的项目规则。
需要模型API调用? 免费领10W Token,多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. agents.md 的六大核心模块解析
2.1 开发命令:让 AI 知道如何操作你的项目
在最近的一个 React 项目中,我深刻体会到精确命令的重要性。之前 AI 总是用 npm 安装依赖,而我们的项目用的是 pnpm。一个简单的 agents.md 配置就解决了这个问题:
markdown复制## 开发命令
- 安装依赖:`pnpm install`
- 启动开发服务器:`pnpm dev`(端口 3000)
- 生产环境构建:`pnpm build`(输出到 dist/ 目录)
- 运行测试:`pnpm test`(使用 Vitest)
- 代码格式化:`pnpm format`(Prettier + ESLint)
关键技巧:
- 使用反引号包裹完整命令
- 注明关键参数(如端口号)
- 说明命令的输出结果
2.2 测试规范:确保 AI 生成的代码可验证
在我的一个开源库项目中,AI 经常生成没有测试的代码。通过 agents.md 明确测试要求后,情况完全改变:
markdown复制## 测试要求
- 单元测试覆盖率 ≥80%
- 测试文件与源码同目录,后缀为 `.test.ts`
- 快照测试需定期更新:`pnpm test -u`
- 测试数据放在 `__fixtures__` 目录
实测案例:
- 之前:AI 生成的工具函数 60% 没有测试
- 之后:95% 的新代码都附带符合规范的测试
2.3 项目结构:防止文件"迷路"
最让我头疼的是 AI 总把组
