SkillPedia Skills Encyclopedia
中文 EN
Today's updates 2026-11-17 UTC

No new commits yet today

Open the update feed

AI & LLMs · Intermediate

AGENTS.md(项目约定文件)

放在项目里写给 AI 看的一份说明,交代这个项目的技术栈、代码规范和注意事项。AI 一进项目读到它,就知道该按什么方式干活。

AI & LLMs Intermediate Appears 20 times across the site, in 11 entries 425 characters about 1 min read 45 views

Some fields on this page have no English version yet — they are shown in the original Chinese.

TL;DRIn 30 seconds

  1. 放在项目里、专门写给 AI 看的一份说明,交代这个项目的规矩和注意点。
  2. AI 一进项目读到它,就知道该按什么技术栈、什么风格干活。
  3. 它随项目走,换个工具换个人接手,约定都还在。

OverviewIn detail

AGENTS.md 是放在项目目录下的一个文本文件,读者是 AI 而不是人。里面记着这个项目用什么语言、什么框架、代码怎么写、哪些地方不要乱动。AI 编程助手打开项目时先读它,后面的动作就有了依据。它主要是给 AI 读的,但人也可以照着它检查 AI 有没有跑偏。

项目里不放这份文件,AI 每次接手都是两手空空,只能按自己的通用习惯来:命名风格和你项目对不上,改了不该改的配置,重复实现已经有的功能。这些问题不是它不聪明,而是没人告诉它规矩。把说明写进项目,相当于贴了一张新人须知,谁来都先看一遍,省得每次口头交代。

它的另一个好处是随项目走。文件放在仓库里,换一台机器、换一个 AI 工具、换一个人接手,约定都还在,不会随着某次对话结束而消失。团队里几个人共用同一份说明,做法也更容易保持一致。

容易和 SKILL.md 搞混。SKILL.md 描述的是一个技能怎么用,管的是能力;AGENTS.md 描述的是一个项目有什么规矩,管的是场地。两者都是给 AI 看的文字说明,但一个跟着技能走、一个跟着项目走,分清楚这两个位置,就不容易放错。

MythsCommon misunderstandings

  • 以为它和技能说明是一回事 技能说明管一项能力怎么用,这份管一个项目的规矩,位置不同
  • 以为口头交代过就够了 对话一结束交代就散了,写进项目里才换人换工具都还在
  • 以为写一次能用到底 项目换了技术栈或目录结构,这份说明也得跟着改

In practiceWhere you will meet it

  • 接手一个新项目,先看目录里有没有这份说明,了解它的约定
  • 在项目里写下“哪些配置不要动”,省得 AI 每次都改错地方
  • 发现 AI 的命名风格总跟项目对不上,把规范补进这份文件

SummaryThe key points

  • 放在项目里、专门写给 AI 看的说明文件
  • 记录技术栈、代码规范和注意事项
  • 让 AI 一进项目就知道按什么规矩做事
  • 它管项目规矩,和管技能用法的 SKILL.md 不同

FAQ

What does AGENTS.md(项目约定文件) mean?

放在项目里、专门写给 AI 看的一份说明,交代这个项目的规矩和注意点。AI 一进项目读到它,就知道该按什么技术栈、什么风格干活。它随项目走,换个工具换个人接手,约定都还在。

Where will I run into AGENTS.md(项目约定文件)?

接手一个新项目,先看目录里有没有这份说明,了解它的约定;在项目里写下“哪些配置不要动”,省得 AI 每次都改错地方;发现 AI 的命名风格总跟项目对不上,把规范补进这份文件。

What do people most often get wrong about AGENTS.md(项目约定文件)?

以为它和技能说明是一回事 — but 技能说明管一项能力怎么用,这份管一个项目的规矩,位置不同;以为口头交代过就够了 — but 对话一结束交代就散了,写进项目里才换人换工具都还在。

What are the key points about AGENTS.md(项目约定文件)?

放在项目里、专门写给 AI 看的说明文件;记录技术栈、代码规范和注意事项;让 AI 一进项目就知道按什么规矩做事;它管项目规矩,和管技能用法的 SKILL.md 不同。

Common pitfalls 约定写进项目比每次在对话里口头交代更可靠,换工具换人也照样生效。

Entry 31 of 186 · All entries

Keep readingRelated reading

Where to go nextExplore more

Back to the skills themselves

Most of the concepts covered here come from skills that install into your AI client with a single command.