CLAUDE.md:90%人用错了
CLAUDE.md:90%人用错了
我用这个文件,让AI记住我项目的所有秘密。
先讲个故事
上周,团队新来一个实习生。
我让他帮改个功能,3小时没搞定。后来我自己上,10分钟改完了。
差距在哪?
不是我比他强,是我知道这个项目的所有破事。
哪个文件是干什么的、哪些代码碰不得、接口在哪、全局变量叫什么——我全清楚。
AI也一样。
CLAUDE.md 是什么
简单说:给AI看的项目说明书。
你创一个文件叫CLAUDE.md,扔项目根目录。每次启动Claude Code,它自动就读。
就这?
对,但90%人写不对。
常见错误
1. 当 README 写
❌
# 这个项目叫XXX使用React + Node 安装:npminstall这不是给AI看的,是给人看的。
2. 写得太简略
❌
项目技术栈:Next.jsAI需要知道的是:
- 哪个目录是干嘛的
- 哪些接口能动、哪些不能动
- 编码规范是什么
- 怎么跑测试
3. 一次写完不更新
项目变了,CLAUDE.md没变。久了就不准了。
正确写法
基础版
# 项目概述 这是一个给朋友做的思维导图工具... # 技术栈 - Next.js 14(App Router) - Tailwind CSS - AI接口:OpenAI # 目录结构 /src/app 页面路由 /src/components 组件 /src/lib 工具函数 # 重要文件 - src/app/page.tsx 首页,禁止乱改 - src/lib/ai.ts AI调用逻辑 # 规范 - 组件用 .tsx + .module.css - 不用的代码直接删,别注释进阶版
再加这些:
# 编码规范 - 组件名用 PascalCase - CSS用 BEM 或模块化 - API错误要捕获 # 常见问题 - 导出功能有时失灵,可能是API超时 - 用户登录态存localStorage # 测试 - 测试文件放 __tests__ - 跑测试:npm test核心心法
把AI当新人教。
你招一个新人,你会告诉他:
- 这里是哪
- 干嘛的
- 什么能碰什么不能
- 出了问题找谁
CLAUDE.md就写这些。
我的习惯
每次接新需求,我会先更新CLAUDE.md:
- 加需求背景——这次要做啥
- 标新文件——要新增/改哪些
- 列风险——哪块可能坑
久而久之,AI比我更懂这个项目
你CLAUDE.md怎么写的?评论区聊聊。
