Claude Code 正确使用指南

⚠️ 培训必须遵循的核心原则

一、Claude Code 的正确使用流程

✅ 正确的流程（必须按此顺序）

Step 1: 访问 Claude Code

1. 打开浏览器访问 https://claude.ai/code
2. 登录账号（或注册新账号）
3. 进入 Claude Code 界面

Step 2: 创建 CLAUDE.md（最重要！）

# 在项目根目录创建 CLAUDE.md
cat > CLAUDE.md << 'EOF'
# 项目名称

## 项目概述
[项目的详细描述]

## 项目目标
[明确的目标列表]

## 技术架构
[技术栈选择]

## 项目结构
[目录结构说明]

## API 设计
[如果是 API 项目]

## 数据模型
[数据结构定义]

## 开发规范
[编码标准]

## 当前任务
[优先级任务]
EOF

Step 3: 让 Claude 读取项目

在 Claude Code 中：
1. 点击"打开项目"
2. 选择包含 CLAUDE.md 的目录
3. Claude 自动读取并理解项目上下文

Step 4: 开始对话开发

现在可以说：
"根据 CLAUDE.md 的设计，帮我实现 [具体功能]"

二、常见错误示范 ❌

❌ 错误1：不创建 CLAUDE.md 直接对话

错误做法：
直接问 Claude："帮我创建一个 TODO API"

问题：
- Claude 不了解项目上下文
- 生成的代码可能不符合需求
- 每次都要重复说明

❌ 错误2：先写代码后补 CLAUDE.md

错误做法：
1. 先创建 index.js
2. 写了一些代码
3. 最后才创建 CLAUDE.md

问题：
- Claude 无法理解已有代码的设计意图
- 容易产生不一致的代码风格

❌ 错误3：CLAUDE.md 内容过于简单

错误的 CLAUDE.md：
# TODO 项目
做一个 TODO 应用

问题：
- 信息太少，Claude 无法准确理解
- 需要反复补充说明

三、CLAUDE.md 最佳实践

📝 完整的 CLAUDE.md 模板

# [项目名称]

## 项目概述
[2-3句话说明项目是什么，解决什么问题]

## 项目目标
1. [具体可衡量的目标1]
2. [具体可衡量的目标2]
3. [具体可衡量的目标3]

## 技术决策
- **编程语言**: [例如 Node.js 18+]
- **框架**: [例如 Express 4.x]
- **数据库**: [例如 PostgreSQL]
- **其他**: [其他重要技术选择]

## 项目结构

project-root/ ├── CLAUDE.md # 项目说明（本文件） ├── src/ # 源代码 │ ├── routes/ # 路由定义 │ ├── controllers/ # 控制器 │ ├── models/ # 数据模型 │ ├── services/ # 业务逻辑 │ └── utils/ # 工具函数 ├── tests/ # 测试文件 ├── docs/ # 文档 └── package.json # 依赖配置


## API 设计（如适用）
### 用户模块
- `GET /api/users` - 获取用户列表
- `POST /api/users` - 创建用户
- `GET /api/users/:id` - 获取用户详情
- `PUT /api/users/:id` - 更新用户
- `DELETE /api/users/:id` - 删除用户

## 数据模型
### User
```json
{
  "id": "string",
  "email": "string",
  "name": "string",
  "created_at": "datetime"
}

开发规范

使用 TypeScript 进行类型检查
遵循 RESTful API 设计原则
所有异步操作使用 async/await
添加适当的错误处理
编写单元测试

当前优先级

🔴 高: [紧急任务]
🟡 中: [重要任务]
🟢 低: [可选任务]

特殊要求

[任何特殊的业务逻辑]
[性能要求]
[安全要求]


---

## 四、培训中的教学要点

### 1. 第一节课必须教的内容

```markdown
培训师："今天第一个重要知识点：Claude Code 的一切从 CLAUDE.md 开始！"

演示流程：
1. 创建项目目录
2. 立即创建 CLAUDE.md
3. 编写完整的项目说明
4. 然后才开始其他操作

强调："没有 CLAUDE.md，Claude 就像盲人摸象"

2. 正确的项目初始化顺序

# 正确顺序
mkdir my-project
cd my-project
vim CLAUDE.md        # 1. 先创建 CLAUDE.md
npm init -y          # 2. 再初始化项目
npm install express  # 3. 最后安装依赖

3. 与 Claude 对话的正确方式

✅ 正确：
"根据 CLAUDE.md 中的用户管理模块设计，实现用户注册功能"

❌ 错误：
"帮我写一个用户注册功能"

五、Agent 和其他组件的正确创建顺序

标准流程

CLAUDE.md - 项目配置（必须第一个）
.claude/agents/ - Agent 定义
.claude/commands/ - 自定义命令
.claude/skills/ - 可复用技能
src/ - 源代码

为什么这个顺序很重要？

CLAUDE.md 定义了项目的"灵魂"
    ↓
Agents 基于项目需求创建
    ↓
Commands 实现特定操作
    ↓
Skills 提供可复用能力
    ↓
最后才是具体代码实现

六、培训材料修正清单

需要检查和修正的内容

所有模块都应该先教创建 CLAUDE.md
移除"检查 node 版本"等基础操作
添加"如何访问 Claude Code"的说明
强调 CLAUDE.md 的重要性
提供完整的 CLAUDE.md 模板
教学案例都应该包含完整的 CLAUDE.md

每个模块的开头应该是

模块 X 教学开始：

"首先，让我们为这个模块的项目创建 CLAUDE.md..."

[提供完整的 CLAUDE.md 内容]

"有了项目配置，现在我们可以开始实现功能了..."

七、给培训师的提醒

🚨 红线原则

永远不要跳过 CLAUDE.md
不要让学员直接与 Claude 对话而不创建项目配置
不要检查版本，直接教怎么用
不要问基础问题，直接给解决方案

✅ 最佳实践

每个项目都从 CLAUDE.md 开始
CLAUDE.md 要详细、完整、专业
教会学员利用 CLAUDE.md 引导 Claude
强调 CLAUDE.md 是单一真实来源

八、学员常见问题

Q: 为什么一定要先创建 CLAUDE.md？

A: CLAUDE.md 是 Claude Code 理解项目的唯一方式。没有它，Claude 就不知道项目的目标、结构和规范。

Q: CLAUDE.md 应该多详细？

A: 越详细越好。包括项目目标、技术架构、API 设计、数据模型、开发规范等。

Q: 可以修改 CLAUDE.md 吗？

A: 当然可以！随着项目发展，应该持续更新 CLAUDE.md，保持它始终反映项目现状。

Q: Claude 会自动读取 CLAUDE.md 吗？

A: 是的，当你在 Claude Code 中打开项目时，它会自动读取并理解 CLAUDE.md。

记住核心原则：

CLAUDE.md First, Everything Else Second!

本指南是培训的核心参考，所有培训内容都应遵循这些原则

FilesExpand file tree

Claude-Code-正确使用指南.md

Latest commit

History