如何写好 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 的表现就越稳定。

相关推荐
_冷眸_6 小时前
Voyago:龙虾(OpenClaw)驱动的一站式旅行规划套件
人工智能·自然语言处理·aigc·agent·claude code
从负无穷开始的三次元代码生活7 小时前
Claude Code CLI常见生产环境指令开发项目入门学习0-1
cli·claude code
Orange_sparkle13 小时前
claude code高级使用手册
python·ai·claude code
小酒窝.1 天前
【Claude Code】记忆管理与压缩,真·源码分析
ai 应用·claude code
yyk的萌1 天前
Claude Code 命令大全
linux·运维·服务器·ai·claude code
九章智算云1 天前
一份CLAUDE.md,为何能让GitHub榜首项目狂揽6万星?
人工智能·ai·大模型·agent·ai工具·claude code·vibe-coding
不做超级小白1 天前
白嫖计划之LongCat一日体验
ai编程·claude code·longcat
维元码簿2 天前
Claude Code 深度拆解:上下文里有什么——工具能力声明
ai·agent·claude code·ai coding
❀͜͡傀儡师2 天前
Claude Code 官方弃用 npm 安装方式:原因分析与完整迁移指南
前端·npm·node.js·claude code