第6章：AGENTS.md编写规范
一、学习目标
掌握 AGENTS.md 的作用、结构和团队协作规范。
完成本章后，学员应能把相关概念转化为可执行的 Codex 任务，并能说明任务的边界、风险和验收方式。
二、本章适合谁学习
团队负责人、项目维护者、高频使用者。
三、核心概念讲解
AGENTS.md 是写给 AI 编程代理的项目说明书。它不替代 README，而是补充“代理执行任务时必须知道的规则”：如何安装、如何测试、代码风格、目录边界、提交规范、禁止事项和安全提醒。一个好的 AGENTS.md 能显著降低重复解释成本。
在教学时，讲师应避免只展示“神奇结果”。更有效的方式是把任务输入、Codex 的中间判断、文件改动、验证命令和最终总结完整展示出来，让学员理解可复制的方法，而不是记住一次偶然成功的演示。
四、关键知识点
写清项目启动、测试、格式化和构建命令。
写清架构边界和常见坑。
写清权限、安全、数据和凭证规则。
保持短而准，随项目演进更新。
五、操作步骤或实践流程
明确任务目标：用一句话写清要解决的问题。
补充上下文：说明项目、目录、相关文件、技术栈和限制。
设定边界：说明哪些文件可以改、哪些不能改、哪些操作需要确认。
要求计划：复杂任务先让 Codex 给出步骤，不立即修改。
执行小步修改：每一步都保持可审阅。
运行验证：优先使用项目已有的 lint、test、build 或人工验收清单。
复盘输出：要求 Codex 总结改动、风险和后续建议。
六、典型案例
团队规定数据库迁移必须人工确认。把这条写入 AGENTS.md 后，Codex 在涉及 schema 的任务中会先提示风险，而不是直接生成迁移。
推荐示例提示词：
请先阅读当前项目中与本任务相关的文件，输出你的理解、可能影响范围和建议修改计划。暂时不要修改文件。确认计划后，再按最小改动实现，并运行可用的验证命令。最后请总结修改内容、验证结果和剩余风险。
本章实践任务：为一个示例项目创建 AGENTS.md，包含环境、测试、代码风格和禁止事项。
七、常见错误与避坑指南
把 README 全部复制进去。
写成抽象口号，没有命令和边界。
项目变化后不维护。
避坑原则：凡是会影响生产数据、权限、支付、认证、数据库迁移、凭证、批量删除或外部服务调用的任务，都应提高审批级别，并要求 Codex 先解释风险。
八、课堂练习
评审一份糟糕的 AGENTS.md，并改写成可执行版本。
练习交付物应包括：任务提示词、Codex 输出摘要、人工审阅意见、验证结果和复盘结论。
九、课后作业
为自己的项目提交一版 AGENTS.md 草案。
作业提交格式建议：
### 任务背景 ### Codex 提示词 ### Codex 执行过程摘要 ### 修改或输出结果 ### 验证证据 ### 人工复盘
十、商业化交付建议
十一、本章小结
本章的关键不是记住单个命令，而是形成“目标明确、上下文充分、边界清楚、过程可审阅、结果可验证”的 Codex 协作方式。只要这个框架稳定，后续无论使用 CLI、IDE、云端任务还是团队流程，都能保持较高质量。
十二、参考资料
OpenAI Codex 官方文档首页
Codex Prompting Guide
openai/codex
How OpenAI uses Codex