Skip to content

Claude 版标准化 MD 文件集

Claude 版的核心是 CLAUDE.md。它负责告诉 Claude Code:这个项目是什么、怎么运行、怎么验证、哪些文件不能碰、团队希望它如何工作。

推荐文件树

text
project-root/
├── CLAUDE.md
├── CLAUDE.local.md
├── README.md
├── CONTRIBUTING.md
├── SECURITY.md
├── docs/
│   ├── product/PRD.md
│   ├── architecture/OVERVIEW.md
│   ├── architecture/FRONTEND.md
│   ├── architecture/BACKEND.md
│   ├── api/API_SPEC.md
│   ├── development/SETUP.md
│   ├── development/CODING_STANDARDS.md
│   ├── development/REVIEW_CHECKLIST.md
│   ├── testing/TEST_STRATEGY.md
│   ├── operations/DEPLOYMENT.md
│   └── ai/
│       ├── PROMPTING.md
│       ├── CLAUDE_COMMANDS.md
│       └── TASK_TEMPLATES.md
└── .claude/
    ├── commands/
    └── agents/

CLAUDE.md 示例

markdown
# CLAUDE.md

## 项目概览

这是一个前后端分离项目:

- 前端:React + TypeScript + Vite
- 后端:Node.js + NestJS
- 数据库:PostgreSQL
- API 文档:docs/api/API_SPEC.md

## 常用命令

- 安装依赖:pnpm install
- 前端开发:pnpm --filter web dev
- 后端开发:pnpm --filter api dev
- 类型检查:pnpm typecheck
- 单元测试:pnpm test
- 构建:pnpm build

## 目录约定

- 前端页面位于 apps/web/src/pages/
- 前端组件位于 apps/web/src/components/
- 后端模块位于 apps/api/src/modules/
- 数据库迁移位于 packages/db/migrations/

## 工作规则

- 修改代码前先阅读相关模块。
- 不要直接改生成文件和构建产物。
- 涉及 API 变更时同步更新 docs/api/API_SPEC.md。
- 涉及环境变量时同步更新 docs/operations/ENVIRONMENT.md。

## 完成标准

- 代码变更后运行 pnpm typecheck 和 pnpm test。
- API 或架构变更后更新对应文档。
- 最终回答说明修改文件、验证命令和剩余风险。

CLAUDE.local.md 示例

CLAUDE.local.md 用于个人本地信息,不应该提交 Git。

markdown
# CLAUDE.local.md

## 本地环境

- 前端端口:http://localhost:5173
- 后端端口:http://localhost:3000
- 本地数据库:localhost:5432/app_dev

## 个人偏好

- 回答使用中文。
- 完成修改后给出简短变更摘要。

Claude 专属补充

文件用途
.claude/commands/commit.md固化提交流程
.claude/commands/review.md固化代码审查流程
.claude/agents/code-reviewer.md专门的代码审查子代理
docs/ai/CLAUDE_COMMANDS.md团队命令说明

适用场景

Claude 版适合已经重度使用 Claude Code、slash commands、subagents、hooks 的团队。重点是让 Claude 读到稳定的项目记忆,并把重复流程沉淀成命令和代理。