官方文档
返回文档与指南
PRACTICAL GUIDE / 配置与上下文

CLAUDE.md:让项目约定持续生效

写清项目结构、验证命令与协作规则,把重复解释变成可维护的文档。

这是一份社区导读。阅读时可结合文末来源,核对当前版本的完整说明。 打开简体中文官方原文

01把稳定事实放进项目记忆

CLAUDE.md 适合记录每次会话都需要知道的事实,例如构建命令、关键目录、编码约定和验收标准。多步骤操作流程更适合拆成 Skill。

根目录 CLAUDE.md 可随项目版本管理;个人偏好和项目通用规则应分开维护。重要限制还需要真实权限配置来执行,文字约定本身不是访问控制。

02一个简洁的项目模板

以下模板需要替换成真实命令。不存在的测试命令、失效路径和过度宽泛的要求,都会让后续任务浪费时间。

TERMINAL / CONFIG
# 项目约定

## 开发
- 安装依赖:npm ci
- 本地开发:npm run dev
- 发布构建:npm run build

## 结构
- src/:页面与交互
- content/:结构化内容

## 完成标准
- 说明变更目的和受影响页面
- 运行与变更相符的验证
- 检查窄屏、键盘操作与错误状态

03按范围拆分规则

大型仓库可以用 .claude/rules/ 组织规则,并按路径约束生效范围。把某一模块的约定放到对应模块附近,减少所有会话都要读入的内容。

  • 把重复纠正的问题写成一条具体规则。
  • 删除 Claude 能直接从代码中推断的冗余说明。
  • 通过 /context 核对记忆文件是否被加载。
  • 规则变更也走代码评审,避免相互矛盾。

04把记忆作为代码的一部分维护

当构建工具、目录结构或部署方式变化时,同步修改项目记忆。发现规则没被遵守时,先检查加载范围和表述是否可执行,再增加更多文字。

05审查 CLAUDE.md 的三个问题

“换一个开发者还能执行吗?”把只在本机存在的路径、未说明的工具和私人偏好移出团队文件。“项目改变后能同步更新吗?”让命令和目录约定跟随相应实现一起评审。

“每次都需要读这段吗?”如果某段只涉及数据库迁移或发布流程,拆成单独 Skill;如果只影响某类文件,考虑路径规则。保持主文件短且重要。

  • 给每条规则一个明确动作和触发条件。
  • 避免多个文件重复维护同一份长清单。
  • 定期删除已失效、已默认满足或互相冲突的规则。
GO TO THE SOURCE

参考来源

读完了,下一步是动手实践。
KEEP EXPLORING

接下来,可以看看