如何写好 CLAUDE.md

CLAUDE.md 是什么

CLAUDE.md 可以理解成 Claude Code 的项目记忆文件。

它会告诉 Claude:

  • 这个项目是干什么的
  • 代码怎么组织
  • 团队有哪些规范
  • 哪些命令最常用
  • 哪些事情不能做

写得好的 CLAUDE.md,会显著提升 Claude Code 的稳定性。

为什么它这么重要

因为很多"AI 不听话"的问题,根本不是模型不够聪明,而是系统没有拿到清晰的项目约束。

最推荐写进去的内容

1. 项目基本信息

  • 技术栈
  • 目录结构
  • 关键模块

2. 开发规范

  • 命名规则
  • 组件风格
  • 是否允许引入新依赖

3. 常用命令

  • 安装命令
  • 开发命令
  • 构建命令
  • 测试命令

4. 特别约束

  • 哪些目录不要动
  • 哪些文件修改要谨慎
  • 提交信息风格

一个新手可直接用的模板

复制代码
# 项目说明

- 这是一个 Next.js + TypeScript 项目
- 样式使用 Tailwind CSS
- 页面放在 app/ 目录
- 公共组件放在 components/ 目录

# 开发规范

- 优先复用已有组件
- 不要随意新增依赖
- 变量命名使用 camelCase
- 修改后运行 build 检查

# 常用命令

- 安装依赖:npm install
- 本地开发:npm run dev
- 生产构建:npm run build

# 注意事项

- 不要修改 legacy/ 目录
- 涉及支付逻辑时先给方案,不要直接改

写 CLAUDE.md 的一个原则

不要写废话,要写真正会影响行为的内容。

差的写法:

  • 这是一个很棒的项目
  • 请认真写代码

好的写法:

  • 修改后必须运行 npm run build
  • 不允许新增依赖,除非先说明理由
  • 表单组件统一复用 components/forms

小结

一句话总结:

CLAUDE.md 写的不是介绍词,而是 Claude Code 在这个项目里的长期工作说明书。

写得越具体、越贴近真实约束,Claude Code 的表现就越稳定。

相关推荐
2301_767113988 天前
点过“不再询问”就要检查:Claude Code权限文件也可能存着密钥
git·信息安全·claude code
yz_aiks13 天前
Postman 自动给 Claude Code、Codex、Cursor 装插件怎么查和卸载:本机实测 5 处痕迹(Postman 12.34)
安全·postman·ai编程·开发工具·claude code
VIP_CQCRE16 天前
Claude Code 如何接入 Ace Data Cloud?终端与 VS Code 配置指南
api·ai编程·vs code·claude code·ace data cloud
Aman198417 天前
Claude Code做Unity项目移植(二): 自动执行只读操作,告别频繁的
unity·游戏开发·vibe coding·claude code
GoldenSpider.AI17 天前
一张户型图做成浏览器 3D 漫游:house.json 统一模型、1.2 m 剖切图纸与分阶段验收
ai编程·webgl·three.js·3d漫游·claude code
瓶 盖17 天前
你的 IDE 插件改了 authorized_keys:Claude Code 扩展投毒链路拆解
ide·ssh·vs code·安全分析·供应链安全·claude code
Aman198418 天前
Claude Code做Unity项目移植(一):从零散工具到团队式
unity·游戏开发·vibe coding·claude code·项目迁移
deepseek2318 天前
Claude Code 2.1.314 新增工作目录写入边界:工具权限、沙箱与安全盲区怎么分层
人工智能·ai agent·claude code
yz_aiks18 天前
WorkBuddy 使用技巧:Claude Code 国内平替,签到免费用、自动签到和手机远程控制电脑
人工智能·ai编程·效率工具·claude code·workbuddy
A.说学逗唱的Coke19 天前
【大模型专题】大模型怎么选(2026 年 10 月版):从 20 个模型里挑对那 3 个,以及 Agent 按角色分模型的实操矩阵
ai agent·claude code·大模型选型·模型路由·多模型编排