用CLAUDE.md文件解决"每次开新对话都要重新交代项目背景"的问题。把它当作项目的技术名片和长期记忆库。
文件定位
- 放在项目根目录:
/CLAUDE.md或/.claude/CLAUDE.md - 对话开始时主动提及:"请先看CLAUDE.md了解项目背景"
- 文件会被Claude自动读取并作为上下文保留
核心内容结构
# 项目速览
- 目标:一句话说明项目用途
- 技术栈:Next.js + TypeScript + Prisma(具体版本号)
- 关键约束:Node 18+、PostgreSQL 14+
# 架构约定
- 文件组织:src/{features,shared,lib}/ 分层
- 命名规则:组件大驼峰、hooks小驼峰带use前缀
- 禁止事项:勿在组件内直接调API,必须经过service层
# 上下文清单
- 数据库schema文件位置:prisma/schema.prisma
- 环境变量模板:.env.example(真实值在.env.local)
- 重要业务逻辑入口:src/features/auth/auth.service.ts
# 常见坑点
- 本地开发需先启动docker-compose up db
- 测试账号:admin/test@example.com / Test123!
维护规则
- 代码重构后必须同步更新CLAUDE.md
- 新增技术债或临时方案时添加"注意"区块
- 每月回顾一次,删除已失效的信息
实战技巧
- 复杂项目可分拆为
CLAUDE.md(总览)+.claude/api-guide.md(专项) - 遇到报错时,把错误信息追加到CLAUDE.md的"近期问题"章节,下次同类错误Claude能直接参考历史解决方案
- 不要粘贴敏感信息(密码、密钥),只放架构和流程信息
效果验证
新对话中Claude应能直接说出:"根据CLAUDE.md,这是一个Next.js项目,使用feature-based文件夹结构...",无需你重复解释。