这个提示词用来做什么

想让 Codex / Claude Code / Cursor 这些编码 Agent 稳定按同一套规矩干活,需要一份写得像指令、而不是像项目简介的 AGENTS.md

提示词全文

我要给这个项目写或者改一份 AGENTS.md,帮我定稿。

## 已知信息
项目是什么、什么技术栈:{一两句}
跑起来 / 构建 / 测试的命令:{有就填,没有写「不清楚」}
代码风格与约定:{命名、目录组织、格式化工具、提交信息规范等}
绝对不能动的东西:{生成文件 / 生产配置 / 密钥 / 某些目录}
希望它默认怎么干活:{比如先写测试、改动尽量小、不确定先问}

## 要求
1)只写「Agent 看完能直接照着做」的句子:给具体命令、具体路径、具体取舍,不要写「保持代码优雅」这种没法执行的话。
2)分成:项目概览 / 常用命令 / 代码约定 / 边界与禁区 / 提交与部署。
3)每一条都自问一句:这句话能不能让 Agent 在两个选项之间选对?不能就删掉或改写。
4)补一句与其他文档的分工:README 给人看怎么用,AGENTS.md 给 Agent 看怎么改,别互相重复。
5)最后指出我这版信息里哪些是缺失或自相矛盾的,列成待补清单。

怎么用

  1. 把上面的提示词全文复制到对话窗口或工作流里。
  2. 把花括号占位符(如 {任务描述})替换成你自己的内容。
  3. 条目越具体,产出越稳定;不需要的条目可以直接删掉。

输出示例

AGENTS.md 最常见的失败是写成了项目简介——全是背景,没有一条能约束行为。判断标准很实在:删掉某句话,Agent 的行为不会有任何变化,那这句话就不该占地方。

基本信息

  • 分类:工程
  • 标签:AGENTS.md · 工程规范 · 编码 Agent · 协作
  • 收录日期:2026-10-13

同类提示词