Claude Code Workflow 文档

简体中文

English

简体中文

English

最佳实践 ​

一句话定位 ​

最佳实践是团队高效协作的保障 — 规范制定、代码审查、文档维护、团队协作的实践经验总结。

6.1 团队协作规范 ​

6.1.1 角色职责定义 ​

角色职责技能要求
Planner需求分析、任务分解架构思维、沟通能力
Developer代码实现、单元测试编码能力、测试意识
Reviewer代码审查、质量把关代码敏感度、规范理解
QA质量保证、测试验证测试设计、风险识别
Facilitator协调沟通、进度跟踪项目管理、冲突解决

6.1.2 工作流选择 ​

场景推荐工作流理由
新功能开发PlanEx规划与执行分离，降低风险
Bug 修复Lifecycle完整闭环，确保修复质量
代码重构IterDev迭代改进，持续优化
技术决策Brainstorm多视角分析，全面考虑
Issue 管理Issue可追溯，易管理
UI 开发UIDesign设计到代码无缝衔接

6.1.3 沟通协议 ​

消息格式 ​

[<角色>] <操作> <对象>: <结果>

示例:
[Planner] 任务分解完成: 生成 5 个子任务
[Developer] 代码实现完成: user-auth.ts, 324 行
[Reviewer] 代码审查完成: 发现 2 个问题，建议 1 处优化

状态报告 ​

状态含义后续动作
pending待处理等待依赖完成
in_progress进行中继续执行
completed已完成可以被依赖
blocked被阻塞需要人工介入

6.2 代码审查流程 ​

6.2.1 审查维度 ​

维度检查项严重性
正确性逻辑正确、边界处理HIGH
性能算法效率、资源使用MEDIUM
安全注入漏洞、权限检查HIGH
可维护性代码清晰、模块化MEDIUM
测试覆盖单元测试、边界测试MEDIUM
规范符合编码规范、项目约定LOW

6.2.2 审查流程 ​

6.2.3 审查清单 ​

代码正确性 ​

  • [ ] 逻辑正确，无 bug
  • [ ] 边界条件处理
  • [ ] 错误处理完整
  • [ ] 资源释放正确

性能 ​

  • [ ] 算法复杂度合理
  • [ ] 无内存泄漏
  • [ ] 无冗余计算
  • [ ] 缓存策略合理

安全 ​

  • [ ] 无 SQL 注入
  • [ ] 无 XSS 漏洞
  • [ ] 权限检查完整
  • [ ] 敏感数据保护

可维护性 ​

  • [ ] 命名清晰
  • [ ] 模块化良好
  • [ ] 注释充分
  • [ ] 易于测试

测试覆盖 ​

  • [ ] 单元测试完整
  • [ ] 边界测试覆盖
  • [ ] 异常情况测试
  • [ ] 集成测试验证

规范符合 ​

  • [ ] 编码风格统一
  • [ ] 命名规范遵守
  • [ ] 项目约定遵循
  • [ ] 文档完整

6.2.4 反馈格式 ​

markdown
## 审查结果

### 问题
1. **[HIGH]** SQL 注入风险
   - 位置: `src/auth/login.ts:45`
   - 建议: 使用参数化查询

2. **[MEDIUM]** 性能问题
   - 位置: `src/utils/cache.ts:78`
   - 建议: 使用 LRU 缓存

### 建议
1. 命名优化: `data` → `userData`
2. 模块拆分: 建议将 Auth 逻辑独立

### 通过条件
- [ ] 修复 HIGH 问题
- [ ] 考虑 MEDIUM 建议

6.3 文档维护策略 ​

6.3.1 文档分类 ​

类型位置更新频率负责人
规范文档.workflow/specs/按需架构师
参考文档docs/ref/每次变更开发者
指南文档docs/guide/每月技术写手
API 文档docs/api/自动生成工具
FAQdocs/faq.md每周支持团队

6.3.2 文档更新触发 ​

事件更新内容
新增功能添加功能文档和 API 参考
规范变更更新规范文档和迁移指南
Bug 修复更新 FAQ 和已知问题
架构变更更新架构文档和决策记录
代码审查补充缺失的注释和文档

6.3.3 文档质量标准 ​

标准要求
准确性与实际代码一致
完整性覆盖所有公开 API
清晰性易于理解，示例充分
时效性及时更新，不滞后
可导航结构清晰，易于查找

6.4 Memory 管理最佳实践 ​

6.4.1 Memory 记录时机 ​

时机记录内容
架构决策技术选型、设计决策
问题解决Bug 根因、解决方案
经验总结最佳实践、避坑指南
规范约定编码规范、命名约定
已知问题Bug、限制、TODO

6.4.2 Memory 格式规范 ​

markdown
## [类型] 标题

### 背景
- **问题**: ...
- **影响**: ...
- **上下文**: ...

### 分析/决策
- **方案**: ...
- **理由**: ...
- **替代方案**: ...

### 结果
- **效果**: ...
- **数据**: ...

### 相关
- [相关记忆](memory-id)
- [相关代码](file-link)
- [相关文档](doc-link)

6.4.3 Memory 维护 ​

维护项频率内容
去重每周合并重复记忆
更新按需更新过时内容
归档每月归档历史记忆
清理每季度删除无用记忆

6.5 Hook 使用规范 ​

6.5.1 Hook 类型 ​

Hook 类型用途示例
pre-command注入规范、加载上下文自动加载 CLAUDE.md
post-command保存 Memory、更新索引自动保存决策
pre-commit代码审查、规范检查自动运行 Lint
file-change自动格式化、更新索引自动格式化代码

6.5.2 Hook 配置原则 ​

原则说明
最小化只配置必要的 Hook
幂等性Hook 执行结果可重复
可恢复Hook 失败不影响主流程
可观测Hook 执行有日志记录

6.6 团队协作技巧 ​

6.6.1 冲突解决 ​

冲突类型解决策略
规范冲突团队讨论，统一规范
技术分歧头脑风暴，数据驱动
进度冲突优先级排序，资源调整
质量冲突制定标准，自动化检查

6.6.2 知识共享 ​

方式频率内容
技术分享每周新技术、最佳实践
代码走查每次 PR代码逻辑、设计思路
文档同步每月文档更新、规范变更
问题复盘每次事故根因分析、改进措施

6.6.3 效率提升 ​

技巧效果
模板化复用成功模式
自动化减少重复工作
工具化提升开发效率
标准化降低沟通成本

6.7 快速参考 ​

工作流选择指南 ​

场景工作流命令
新功能PlanEx/workflow-plan
Bug 修复Lifecycle/unified-execute-with-file
重构IterDev/refactor-cycle
决策Brainstorm/brainstorm-with-file
UI 开发UIDesign/workflow:ui-design

代码审查清单 ​

  • [ ] 正确性检查
  • [ ] 性能检查
  • [ ] 安全检查
  • [ ] 可维护性检查
  • [ ] 测试覆盖检查
  • [ ] 规范符合检查

Memory 维护 ​

操作命令
列出记忆ccw memory list
搜索记忆ccw memory search "..."
导入记忆ccw memory import "..."
导出记忆ccw memory export <id>

总结 ​

Claude Code Workflow 的最佳实践可以总结为：

  1. 规范先行 - 制定清晰的团队规范
  2. 流程保障 - 使用合适的工作流
  3. 质量把关 - 严格的代码审查
  4. 知识沉淀 - 持续维护 Memory 和文档
  5. 持续改进 - 定期复盘和优化

相关链接 ​

Released under the MIT License.

Copyright © 2025-present CCW Contributors