AGENTS.md 不是说明书,而是给智能体看的地图

AGENTS.md 不是说明书,而是给智能体看的地图

学会设计简短、可维护、可渐进披露的 AGENTS.md,让 AI Agent 先读入口,再按任务读取更深层文档。

打开源文档

很多人第一次给 AI 写项目规则,会把所有背景、所有流程、所有偏好都塞进一个超长文件。短期看似完整,长期却会变成上下文噪音。Harness Engineering 提倡“地图而非手册”:入口文件负责指路,细节文件负责解释。

为什么地图更好

AI Agent 的上下文是有限资源。入口文件越长,越容易挤占真正任务需要的代码、错误输出和验证结果。更好的做法是让 AGENTS.md 保持短小,按任务指向对应文档。

源仓库文档转化为教程和学习路径的无文字插图
文内插图:把源仓库文档转化为教程、清单和可验证学习路径。
写法优点风险
巨型说明书信息看似齐全上下文拥挤、难维护、难验证
地图式入口轻量、清晰、可扩展需要维护文档链接
脚本和检查配套能自动发现漂移需要投入一点工程化成本
AGENTS.mddocs/PROJECT.mddocs/ARCHITECTURE.mddocs/OPERATIONS.mdtests / scripts
入口文件只告诉 Agent 哪些文档是下一层上下文。

一个好入口应包含什么

  • 项目一句话定位。
  • 重要目录和真相源。
  • 常用验证命令。
  • 高风险边界,例如生产、数据库、凭证、发布流程。
  • 遇到不同任务时应该继续读哪些文档。

源文档学习快照

这一节由当前 GitHub 源文档生成,用来保证教程正文能跟随仓库变化刷新。当前主源文档:concepts/00-overview.md。

核心概念一句话定义六大核心概念1. 仓库即记录系统(Repo as System of Record)2. 地图而非手册(Map, Not Manual)3. 机械化执行(Mechanical Enforcement)
当源仓库文档更新后,这里的结构和摘要会在同步任务中重新生成。
当前源文档读者应关注同步含义
concepts/00-overview.md来源:OpenAI 2026-02-11,作者 Ryan Lopopolo 背景:3人团队用 Codex 从空仓库到100万行代码,5个月,零…源文档 SHA 会写入文章 meta,正文快照会随同步任务刷新。
  • 一句话定义
  • 六大核心概念
  • 1. 仓库即记录系统(Repo as System of Record)
  • 2. 地图而非手册(Map, Not Manual)
  • 3. 机械化执行(Mechanical Enforcement)