步步图解

AI 工具

写好 CLAUDE.md:给 Claude Code 一份项目说明书

把项目规则写进一个文件,不用每次开新会话都重复交代。

每次新开会话,Claude 都不记得你上次说过的项目规则。CLAUDE.md 就是解决这个问题的:它在会话开始时自动加载,相当于一份项目说明书。

STEP 01 / 05

生成第一版

在项目文件夹里启动 Claude Code,然后输入:

Claude Code
/init

它会分析项目,生成一份包含构建命令、测试命令和代码约定的 CLAUDE.md。如果文件已经存在,它会给出改进建议,不会直接覆盖。

STEP 02 / 05

只写它猜不到的内容

好的说明书要短。官方建议单个文件控制在 200 行左右。优先写这几类:

  • 常用命令,比如怎么运行、怎么测试
  • 不看代码猜不出来的约定
  • 明确不能做的事
  • 输出和沟通偏好

下面是一个小网站项目的例子:

CLAUDE.md
# 项目说明

个人作品集网站,纯静态页面。

## 常用命令
- 本地预览:npm run dev
- 构建:npm run build

## 约定
- 页面文案使用简体中文
- 不引入新的依赖,除非先问我
- 图片放在 public/images/

## 完成标准
- 改完后运行构建,确认没有报错
- 回复时说明改了哪些文件

STEP 03 / 05

放对位置

CLAUDE.md 可以放在不同位置,作用范围也不同:

  • ~/.claude/CLAUDE.md:对你的所有项目生效,放个人习惯。
  • 项目根目录的 CLAUDE.md:只对这个项目生效,可以提交到 Git 和团队共享。
  • 项目根目录的 CLAUDE.local.md:放个人的项目设置,记得加入 .gitignore。

这些文件是叠加生效的,不是互相覆盖。

STEP 04 / 05

拆分长文档

内容变多时,可以用 @路径 引用其他文件,保持主文件简短:

CLAUDE.md
项目背景见 @README.md
发布流程见 @docs/deploy.md

STEP 05 / 05

检查和维护

在 Claude Code 里输入 /memory,可以查看和编辑当前加载的说明文件。

一个实用的维护习惯:Claude 第二次犯同样的错时,就把正确做法加进 CLAUDE.md。说明书不用一次写完,边用边补就好。

资料来源