README.md 和 AGENTS.md 的区别与作用
README.md vs AGENTS.md
一个告诉所有人"这是什么项目",一个专门告诉 Agent"在这里怎么干活"
README.md
项目说明书 · 给所有人看
回答的问题:这个项目是什么?
介绍项目背景、目标、文件结构、怎么安装使用。不管是人还是 Agent,进入一个新项目,第一个读的都是它。存在了几十年,软件界的通用惯例。
类比:公司前台的公司简介手册——不管你是谁,来了先看这个了解基本情况。
README.md
# 新媒体运营工作空间
公司新媒体团队的日常运营资料。覆盖抖音、小红书、公众号、B站四个平台。
## 文件结构
data/ → 各平台原始数据reference/ → 历史周报和参考资料
notes/ → 会议记录和零散笔记
output/ → 产出文件
## 周报要求
每周五提交,需包含数据总结、亮点分析、竞品观察、下周计划四个部分。
AGENTS.md
Agent 行为手册 · 专门给 AI 看
回答的问题:在这个项目里 Agent 该怎么做?
告诉 Agent 工作规范、注意事项、禁止事项、偏好风格。它是专门写给 AI 读的"行为守则"——人能看懂,但主要读者是 Agent。新东西,随着 Agent 普及才出现。
类比:给新员工的内部工作手册——"我们部门怎么做事、哪些红线不能碰、老板喜欢什么风格"。
AGENTS.md
# Agent 工作规范
## 写作风格
用中文。语气正式但不死板。数据要精确到个位。## 必须做的
- 周报必须回应 notes/老板要求.txt 的每一条- 数据从 CSV 计算,不要编造数字
- 产出文件统一放到 output/ 目录
## 禁止做的
- 不要删除 data/ 目录下的任何文件- 不要修改 reference/ 下的历史文档
- 不要在周报中使用 emoji
不同 Agent 框架用不同的文件名,但作用一样
Claude CodeCLAUDE.md放在项目根目录,Agent 自动读取
CodexAGENTS.md或 codex.md,OpenAI 推荐用 AGENTS.md
Cursor.cursorrules放在项目根目录的隐藏文件
通用做法AGENTS.md越来越多框架支持这个通用名称
如果都想兼容两个都写README.md + CLAUDE.md / AGENTS.md 各一份
README.md
AGENTS.md
主要读者
所有人(人 + AI)
专门给 Agent
回答什么问题
这个项目是什么
在这里怎么干活
包含什么内容
项目背景、文件结构、安装使用方法
工作规范、注意事项、禁止事项、偏好
来源
软件界几十年的惯例
2024-2025 年随 Agent 兴起的新做法
没有会怎样
Agent 要自己猜项目是什么
Agent 能干活,但可能不符合你的习惯
类比
公司简介手册
内部工作规范手册
最佳实践:两个都写。README.md 告诉 Agent(和你的同事)"这个项目是做什么的",AGENTS.md 告诉 Agent "在这里要遵守哪些规矩"。Agent 进来后先读 README 了解项目,再读 AGENTS.md 了解规范,然后才开始干活——就像新员工先看公司介绍,再看部门手册,然后上岗。