基本工作流程
了解 Claude Code 的典型工作流程,帮助你更高效地使用这个工具。
典型工作流程
1. 项目探索流程
当你接触一个新项目时:
# 步骤 1:了解项目概览
Claude> 这个项目是做什么的?
# 步骤 2:查看项目结构
Claude> 展示项目的主要目录结构
# 步骤 3:阅读关键文件
Claude> 读取 README.md 和 package.json
# 步骤 4:了解启动方式
Claude> 如何运行这个项目?
# 步骤 5:查看核心代码
Claude> 显示主要业务逻辑文件
# 步骤 6:理解技术栈
Claude> 分析项目使用的技术栈和依赖
# 步骤 7:查看配置文件
Claude> 找出并解释所有配置文件
2. 新功能开发流程
开发新功能时的标准流程:
# 步骤 1:理解需求
Claude> 我需要添加用户登录功能,帮我规划一下
# 步骤 2:设计方案(使用计划模式)
Claude> /plan
Claude> 基于现有架构,设计登录功能的实现方案
# 步骤 3:探索相关代码
Claude> 查找现有的认证相关代码
# 步骤 4:创建必要文件
Claude> 创建登录相关的组件和服务文件
# 步骤 5:实现核心逻辑
Claude> 实现用户认证逻辑
# 步骤 6:添加类型定义
Claude> 为新功能添加 TypeScript 类型
# 步骤 7:编写测试
Claude> 为登录功能编写测试用例
# 步骤 8:集成测试
Claude> 运行完整测试套件
# 步骤 9:代码审查
Claude> 使用 code-reviewer 代理审查代码
# 步骤 10:更新文档
Claude> 更新 API 文档,添加登录接口说明
3. Bug 修复流程
发现和修复问题的流程:
# 步骤 1:定位问题
Claude> 应用在保存数据时崩溃,帮我找出问题
# 步骤 2:分析错误
Claude> 查看错误日志和堆栈跟踪
# 步骤 3:理解上下文
Claude> 检查相关的代码文件
# 步骤 4:实施修复
Claude> 修复数据处理中的空指针错误
# 步骤 5:验证修复
Claude> 运行测试,确保问题已解决
# 步骤 6:预防类似问题
Claude> 添加必要的错误处理和验证
4. 代码审查流程
进行代码审查的最佳实践:
# 步骤 1:查看更改概览
Claude> 显示这次 PR 的所有更改
# 步骤 2:逐文件检查
Claude> 检查 src/user/service.js 的更改
# 步骤 3:分析潜在问题
Claude> 这些更改有什么风险或问题?
# 步骤 4:检查测试覆盖
Claude> 确保所有新代码都有测试
# 步骤 5:性能影响
Claude> 这些更改对性能有什么影响?
# 步骤 6:提供反馈
Claude> 总结审查意见和改进建议
高效工作技巧
1. 善用上下文
Claude Code 会记住上下文,利用这一点:
# 不好的方式 - 每次都重复上下文
Claude> 在 /home/user/project/src/components/UserCard.js 中找到用户名显示的地方并修改
Claude> 在 /home/user/project/src/components/UserCard.js 中添加头像显示
# 好的方式 - 利用上下文
Claude> 查看 UserCard 组件
Claude> 修改用户名显示方式
Claude> 添加头像显示功能
2. 批量操作
将相关操作组合在一起:
# 不好的方式 - 多次单独操作
Claude> 创建 utils.js
Claude> 添加 formatDate 函数到 utils.js
Claude> 添加 validateEmail 函数到 utils.js
# 好的方式 - 一次性完成
Claude> 创建 utils.js 文件,包含格式化日期和验证邮箱的函数
3. 渐进式复杂任务
对于复杂任务,采用渐进式方法:
# 任务:重构认证系统
# 第一阶段:理解现有系统
Claude> 分析当前的认证实现,梳理所有相关文件
# 第二阶段:设计新架构
Claude> 基于发现的问题,设计新的认证架构
# 第三阶段:逐步迁移
Claude> 先迁移用户模型,保持接口兼容
# 第四阶段:完善功能
Claude> 添加 JWT 支持和刷新令牌机制
# 第五阶段:清理旧代码
Claude> 删除旧的认证代码,更新所有引用
最佳实践
1. 开始前
- 明确目标:清楚知道要做什么
- 了解上下文:先了解项目结构和相关代码
- 制定计划:对于复杂任务,先制定实施计划
- 检查 CLAUDE.md:查看项目特定的配置和指导
2. 执行中
- 小步快跑:将大任务分解成小步骤
- 及时测试:每完成一个步骤就进行测试
- 保持沟通:让 Claude 了解你的想法和反馈
- 使用思考模式:对复杂问题启用思考模式
- 定期压缩历史:使用
/compact管理上下文
3. 完成后
- 验证结果:确保功能正常工作
- 编写测试:为新功能添加测试
- 更新文档:更新相关文档和注释
- 代码审查:使用专门的代理进行代码审查
4. 真实世界的工作流程
基于 Paige Niedringhaus 的使用经验
# 1. 并行工作模式
# 终端 1:Claude Code
# 终端 2:开发服务器
# IDE:VS Code
# 2. 开始新会话的标准流程
Claude> 我要构建一个新功能:[功能描述]
Claude> 这是相关的代码:@src/features
Claude> 这是文档:@docs/feature-spec.md
# 3. 让 Claude 制定计划
Claude> think about how you would tackle this feature and make a plan
基于 Anthropic 团队的建议
# 1. 使用计划模式进行大型修改
Claude> /plan
Claude> 我要重构这个模块,先分析现有架构
# 2. 使用专门的子代理
Claude> 使用 security-auditor 检查安全漏洞
Claude> 使用 performance-optimizer 优化性能
# 3. 创建自定义命令
# 在 .claude/commands/ 中创建常用流程
5. 团队协作最佳实践
CLAUDE.md 配置
# 项目:电商后端 API
## 技术栈
- Node.js + TypeScript
- PostgreSQL
- Redis
- Docker
## 代码规范
- 使用 ESLint + Prettier
- 遵循 Conventional Commits
- 测试覆盖率 > 80%
## 常用命令
- npm run dev
- npm run test
- npm run build
## 注意事项
- 所有 API 都需要认证
- 使用事务处理数据库操作
- 错误日志要包含 trace id
分支策略
# 功能开发流程
Claude> 创建功能分支 feature/user-auth
Claude> 实现功能并编写测试
Claude> 运行完整测试套件
Claude> 生成 PR 描述
Claude> 创建 pull request
4. 常见陷阱
避免模糊指令
# 模糊的指令
Claude> 优化代码
# 清晰的指令
Claude> 优化 user.js 中的数据库查询,减少 N+1 问题
避免一次性大改
# 不好的做法
Claude> 重构整个项目使用 TypeScript
# 好的做法
Claude> 先将 utils.js 转换为 TypeScript,作为示例
避免忽略测试
# 始终包含测试
Claude> 添加新功能,并编写相应的单元测试
协作工作流程
1. 团队协作
- 统一标准:使用统一的代码风格和约定
- 清晰提交:编写清晰的提交信息
- 及时同步:定期同步和合并更改
2. 交接工作
# 生成交接文档
Claude> 为这个项目生成开发指南,包括:
# - 项目结构说明
# - 本地开发环境搭建
# - 常见任务和命令
# - 注意事项和约定
3. 知识分享
# 创建教程
Claude> 为团队创建一个最佳实践指南
# 记录解决方案
Claude> 记录今天解决的问题和解决方案
下一步
你已经了解了 Claude Code 的基本工作流程。接下来可以:
开始使用 Claude Code 提升你的开发效率吧!