实战二:给 AI 写一份项目说明书
上一讲做网页时你可能发现了:每开一个新对话,都得重新交代一遍"只用一个文件、回复用中文、改完告诉我怎么打开"。这一讲解决这个问题——给 AI 写一份项目说明书。Claude Code 叫它 CLAUDE.md,Codex 叫它 AGENTS.md。写一次,它每次开工前都会先读。
- 写一次,每次开工都先读
CLAUDE.md · AGENTS.md
- 一句话介绍
- 怎么运行
- 目录
- 规矩
- 禁区
- 完成标准
- 踩过的坑
拼起来就是一份管用的说明书
- “代码要规范优雅”
- “改完运行 npm test”
- “注意安全”
- “密钥只从环境变量读”
写成能检查对错的话才管用
- 每纠正一次,就写进去一条
它是什么
项目说明书 = 你给 AI 新同事的入职文档。项目是什么、怎么跑、有什么规矩、哪里不能碰,写清楚,它就不用每次问、你也不用每次说。
| Claude Code | Codex | |
|---|---|---|
| 文件名 | CLAUDE.md | AGENTS.md |
| 项目级 | 放在项目根目录 | 放在项目根目录,子目录也可以各放一份 |
| 全局(所有项目通用) | ~/.claude/CLAUDE.md | ~/.codex/AGENTS.md |
| 快速生成草稿 | 对话里输入 /init | 让它"读一遍项目,写一份 AGENTS.md" |
全局那份适合写"回复用中文""我是新手,解释得通俗点"这种个人习惯;项目那份写这个项目自己的事。
拼一份说明书
一份好用的说明书,通常由这几块组成。点一点,看它拼起来的样子:
- 一句话介绍
- 这是一个卖手工蜂蜜的小网站,纯 HTML + CSS + JavaScript,没有后端。
- 怎么运行
- 本地预览:在项目目录运行 npx serve,然后打开 http://localhost:3000。
- 目录说明
- 页面在 pages/,样式在 css/,图片在 img/(图片不要改名,别的页面引用着)。
- 代码规矩
- 不引入新的第三方库;颜色只用 css/vars.css 里定义好的变量。
- 禁区
- 不要修改 legal/ 目录下的用户协议和隐私政策。
- 完成标准
- 每次改完,在手机宽度下检查一遍页面,确认没有横向滚动条,再告诉我结果。
- 踩过的坑
- Safari 不支持我们用过的某个日期写法,处理日期统一用 dayjs 的格式化函数。
注意看"踩过的坑":这是说明书里最值钱的一块。每次 AI 犯了一个错、你纠正了它,就顺手写进来,它以后就不会再犯。
写成这样才管用
写了等于没写
- 代码要写得规范、优雅
- 注意安全
- 要认真测试
AI 本来就"觉得"自己写得规范。这种话没法检查,等于没说。
能照着做
- 函数名用小驼峰,比如 getUserName
- 密钥只从环境变量读,不准写进代码
- 改完运行 npm test,全部通过再交付
每一条都具体到能检查对错。
- 短。它每次开工都要读一遍,越长越占额度、越容易抓不住重点。一页纸以内最好。
- 具体。写命令、写路径、写例子,不写形容词。
- 常更新。项目变了、规矩变了,说明书跟着改,过时的信息比没有更害人。
- 不放秘密。密钥、密码不写进去,说明书常常会跟着代码一起提交。
两个工具共用一份
同时用 Claude Code 和 Codex 的,不用写两遍。规矩写在 AGENTS.md 里,然后在 CLAUDE.md 里只写一行,让 Claude Code 把它引进来:
@AGENTS.md ## 只给 Claude Code 的补充 - 【比如:动手前先进计划模式,把方案给我看】
Claude Code 的说明书支持用 @文件路径 引入其他文件,同一份规矩,两个工具都能读到。
下面哪一条最适合写进项目说明书?
- "请写出高质量的代码"
- "数据库密码是 abc123,连接时用"
- "上传图片统一压缩到 500KB 以内,用 scripts/compress.js 处理"
- "今天先改首页,明天再改关于页"
第三条具体、长期有效、能检查。"高质量"没法执行;密码绝不能写进去;"今天明天"是一次性的安排,直接在对话里说就行。
课后动手
- 在上一讲的番茄钟文件夹里运行
/init(或让 Codex 写一份 AGENTS.md)。 - 读一遍它生成的草稿,删掉空话,补上至少一条"禁区"和一条"完成标准"。
- 在全局说明书里写上你的个人习惯,比如"回复用中文"。
- 开一个新对话,让它改一处,看它有没有按说明书来。
好的说明书,让 AI 第一天上班就像干了一年的老员工。
评论
0
最新
最早
最热
登录后参与评论
登录
加载中...