AI 记忆体系:AGENTS.md
AI 记忆体系:AGENTS.md
给 AI 建立「记忆」是整个 AI 开发体系里新手最容易忽略、老手最依赖的一环。用了记忆文件,你的 AI 才能从一问三不知的新人变成你一开口就知道该干嘛的老搭档。搞懂它,才算真正学会了「驯 AI」。
AI 记忆:让它一进项目就懂规矩(最重要)
这是新手最容易忽略、老手最依赖的一环。搞懂它,你的 AI 才能从「临时工」变成「老员工」。
🧠 残酷真相:AI 没有记忆
每次新开一个对话,AI 就彻底失忆:忘了你的项目是干嘛的、忘了你们的规范、忘了上次踩过的坑。你不可能每次都从头介绍一遍。
💡 比喻: AI 像一位每天早上都会失忆的天才员工。怎么办?在他工位上贴满便签:「我们公司是做什么的」「文件放在哪」「干活的规矩」。他每天上班先读便签,几分钟就恢复「老员工」状态。这些便签,就是记忆文件。
opencode 等工具约定:启动时自动读取项目里名为 AGENTS.md 的文件(有的工具叫 CLAUDE.md,作用一样)。你把规矩写进去,AI 每次进来先看它。
📌 项目记忆:项目根目录的 AGENTS.md
放在项目根目录,写清楚这个项目的「身份证 + 店规」。AI 一进这个文件夹就自动读,立刻知道怎么干活:
# AGENTS.md —— 放在项目根目录(一个 Markdown 文本文件)
## 项目是什么
待办清单练手项目:Vue3 前端 + Spring Boot 后端 + MySQL。
## 怎么启动
- 前端:cd web 后 npm run dev(端口 5173)
- 后端:IDEA 运行,或 cd server 后 mvn spring-boot:run(端口 8080)
## 代码规范
- 前端组件文件用 kebab-case 命名(如 todo-list.vue)
- 后端接口统一返回 Result 信封(code / message / data)
- 所有日期格式统一 yyyy-MM-dd
## 铁律
- 没让你 commit / push 就不许自己提交
- UPDATE / DELETE 的 SQL 必须带 WHERE
- 改完代码要自己跑一遍验证再汇报提示
立竿见影的效果: 没有这个文件时,你说「加个接口」,AI 可能用它自己的习惯乱写一通;有了它,AI 写出来的代码自动符合你的命名、你的返回格式、你的规矩——就像老员工的手笔。
🗂️ 子目录记忆:大项目里的「分店店规」
项目大了(比如一个仓库里同时有前端 + 后端),可以在子文件夹里再放各自的 AGENTS.md。AI 干哪个文件夹的活,就叠加读哪份规矩:
my-project/
├── AGENTS.md ← 总店规:项目全局介绍、通用铁律
├── web/
│ └── AGENTS.md ← 前端店规:组件规范、目录约定、UI 库用法
└── server/
└── AGENTS.md ← 后端店规:分层规则、SQL 规范、返回格式💡 比喻: 总部有员工手册(根目录),每家分店还有自己的店规(子目录)。员工到哪家店干活,就遵守「总部手册 + 这家店的店规」。
🌍 全局记忆:你的个人偏好,走到哪带到哪
还有一层记忆跟人不跟项目:放在你电脑的用户配置目录里(如 ~/.config/opencode/AGENTS.md),对你打开的所有项目都生效。适合写个人习惯:
# 全局 AGENTS.md —— 个人偏好,所有项目通用
- 永远用中文回复我
- 我是新手,解释问题时多用大白话和比喻
- 给出代码时顺便说明每段是干嘛的
- commit 信息用一句话大白话描述干了什么| 记忆层级 | 放在哪 | 写什么 | 生效范围 |
|---|---|---|---|
| 全局记忆 | 用户配置目录 | 个人偏好:语言、风格、通用习惯 | 你的所有项目 |
| 项目记忆 | 项目根目录 AGENTS.md | 项目介绍、启动命令、规范、铁律 | 这个项目 |
| 子目录记忆 | 子文件夹 AGENTS.md | 该模块的专属约定 | 这个文件夹 |
📈 让记忆越用越值钱:踩坑就记账
记忆文件不是写一次就完事,它是活的,要持续喂养:
- 踩了坑就记。 AI 犯了个错、你们折腾半天才解决——马上说一句:「把这条经验写进 AGENTS.md,以后别再犯」。让 AI 自己更新自己的便签。
- 发现新规矩就记。 「以后所有弹窗都用这个封装好的组件」——记进去,下次它自动照办。
- 提交到 Git,全队共享。 AGENTS.md 就是普通文本文件,跟代码一起提交。同事克隆项目后,他的 AI 也自动懂你们的规矩——相当于给全组的 AI 统一做了岗前培训。
- 定期瘦身。 过时的规矩删掉,太长的合并精简。便签贴太多,等于没贴。
提示
心里有杆秤: 用了三个月后,你的项目记忆文件就是一份「项目上手指南 + 踩坑大全」——不光 AI 受益,新来的同事看它也能快速上手。这是你在 AI 时代积累的新型资产。
什么才算合格
提示
🎯 记忆体系建设自测(建议在练手项目中逐一完成)
- 建了项目记忆: 给练手项目写出了
AGENTS.md(项目介绍 + 启动命令 + 规范 + 铁律),新开对话时 AI 确实按规矩干活 - 建了全局记忆: 配好个人偏好(比如「用中文、多用大白话」),换项目也生效
- 养成记账习惯: 踩过的坑至少往记忆文件里记过一条「以后别再犯」
- 记忆文件是活的: 能持续往 AGENTS.md 里补充新规矩、删除过时内容,让记忆文件越用越准