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

相关推荐
学心理学的程序员2 天前
anydoc:Firecrawl 出的 Rust 文档转 Markdown,4ms 转换、14 种格式干翻 MarkItDown
开发语言·后端·rust·开源·firecrawl·claude code·anydoc
peijiping4 天前
AI多智能体解惑:父子子智能体 vs 团队智能体,为什么主流IDE默认只用前者?
人工智能·ai agent·claude code
creator_Li5 天前
Claude Code 源码分析(九):子 Agent 如何分叉、继续与回到父会话
claude code
creator_Li5 天前
Claude Code 源码分析(八):Memory 如何被写入、整理与按需召回
claude code
AI工具人PM产品经理6 天前
Claude Code skill 自建还是引入?3 个开源项目的改造判断标准
开源软件·技术选型·claude code·技能包·自建vs引入
VIP_CQCRE10 天前
用 Ace Data Cloud 接入 Claude Code:一个 Token 打通终端、VS Code 与 GitHub Actions
api·ai编程·开发工具·claude code·ace data cloud
ArkAPI12 天前
Claude Code 连发安全修复:AI 编程 Agent 的权限,正在成为新的“安全事故高发区”
人工智能·大模型·api·codex·ai工具·claude code·arkapi
peijiping12 天前
大模型 API 缓存命中率深度解析:OpenAI / DeepSeek / Anthropic 三家机制对比与智能体端实践 (学习笔记)
ai agent·claude code·缓存命中
TonyLee01712 天前
Claude Code + DeepSeek:服务器安装与使用笔记
linux·服务器·deepseek·claude code