mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
62ffc5c645
Major improvements to workflow understanding and guidance: 1. New Document: WORKFLOW_DECISION_GUIDE.md - Comprehensive decision flowchart for full software lifecycle - Interactive Mermaid diagram with 40+ decision points - Clear guidance on when to use each command - Real-world scenarios for all workflow types - Quick reference tables by knowledge level, project stage, and mode - Expert tips and common pitfalls 2. Clarified Brainstorm vs Plan Relationship Core concept correction: - Brainstorm: Use when you know WHAT to build, NOT HOW - Plan: Use when you know both WHAT and HOW - Plan can accept user input OR brainstorm output 3. Updated Documentation Files - GETTING_STARTED.md: Added clear distinction and decision criteria - GETTING_STARTED_CN.md: Chinese version with same clarifications - FAQ.md: Enhanced brainstorm usage explanation with workflow comparison table - README.md: Added Workflow Decision Guide link - README_CN.md: Added Chinese link to decision guide 4. Key Improvements When to Use Brainstorming: - Unclear solution approach (multiple ways to solve) - Architectural exploration needed - Requirements clarification (high-level clear, details not) - Multiple trade-offs to analyze - Unfamiliar domain When to Skip Brainstorming: - Clear implementation approach - Similar to existing code patterns - Well-defined requirements - Simple features 5. Decision Flowchart Covers: - Ideation phase (know what to build?) - Design phase (know how to build?) - UI design phase (need UI design?) - Planning phase (complexity level?) - Testing phase (TDD, post-test, test-fix?) - Review phase (security, architecture, quality?) - Completion Benefits: - Eliminates confusion about brainstorm usage - Provides clear decision criteria for all commands - Visual flowchart helps users navigate workflows - Comprehensive coverage of all development stages - Reduces trial-and-error in workflow selection Files modified: 5 Files added: 1 (WORKFLOW_DECISION_GUIDE.md)
198 lines
7.9 KiB
Markdown
198 lines
7.9 KiB
Markdown
# 🚀 Claude Code Workflow (CCW)
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||
[](LICENSE)
|
||
[]()
|
||
|
||
**语言:** [English](README.md) | [中文](README_CN.md)
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
**Claude Code Workflow (CCW)** 将 AI 开发从简单的提示词链接转变为一个强大的、上下文优先的编排系统。它通过结构化规划、确定性执行和智能多模型编排，解决了执行不确定性和误差累积的问题。
|
||
|
||
> **🎉 版本 5.8.1: Lite-Plan 工作流与 CLI 工具增强**
|
||
>
|
||
> **核心改进**:
|
||
> - ✨ **Lite-Plan 工作流** (`/workflow:lite-plan`) - 轻量级交互式规划与智能自动化
|
||
> - **三维多选确认**: 任务批准 + 执行方法 + 代码审查工具
|
||
> - **智能代码探索**: 自动检测何时需要代码库上下文（使用 `-e` 标志强制探索）
|
||
> - **并行任务执行**: 识别独立任务以实现并发执行
|
||
> - **灵活执行**: 选择智能体（@code-developer）或 CLI（Gemini/Qwen/Codex）
|
||
> - **可选后置审查**: 内置代码质量分析，可选择 AI 工具
|
||
> - ✨ **CLI 工具优化** - 简化命令语法，自动模型选择
|
||
> - 移除 Gemini、Qwen 和 Codex 的 `-m` 参数要求（自动选择最佳模型）
|
||
> - 更清晰的命令结构和改进的文档
|
||
> - 🔄 **执行工作流增强** - 简化阶段，采用延迟加载策略
|
||
> - 🎨 **CLI Explore Agent** - 改进可见性，采用黄色配色方案
|
||
>
|
||
> 详见 [CHANGELOG.md](CHANGELOG.md)。
|
||
|
||
> 📚 **第一次使用 CCW？** 查看 [**快速上手指南**](GETTING_STARTED_CN.md) 获取新手友好的 5 分钟教程！
|
||
|
||
---
|
||
|
||
## ✨ 核心概念
|
||
|
||
CCW 构建在一系列核心原则之上，这些原则使其与传统的 AI 开发方法区别开来：
|
||
|
||
- **上下文优先架构**: 通过预定义的上下文收集，消除了执行过程中的不确定性，确保智能体在实现*之前*就拥有正确的信息。
|
||
- **JSON 优先的状态管理**: 任务状态完全存储在 `.task/IMPL-*.json` 文件中，作为唯一的事实来源，实现了无需状态漂移的程序化编排。
|
||
- **自主多阶段编排**: 命令链式调用专门的子命令和智能体，以零用户干预的方式自动化复杂的工作流。
|
||
- **多模型策略**: 充分利用不同 AI 模型（如 Gemini 用于分析，Codex 用于实现）的独特优势，以获得更优越的结果。
|
||
- **分层内存系统**: 一个 4 层文档系统，在适当的抽象级别上提供上下文，防止信息过载。
|
||
- **专门的基于角色的智能体**: 一套模拟真实软件团队的智能体（`@code-developer`, `@test-fix-agent` 等），用于处理多样化的任务。
|
||
|
||
---
|
||
|
||
## ⚙️ 安装
|
||
|
||
有关详细的安装说明，请参阅 [**INSTALL_CN.md**](INSTALL_CN.md) 指南。
|
||
|
||
### **🚀 一键快速安装**
|
||
|
||
**Windows (PowerShell):**
|
||
```powershell
|
||
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content
|
||
```
|
||
|
||
**Linux/macOS (Bash/Zsh):**
|
||
```bash
|
||
bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.sh)
|
||
```
|
||
|
||
### **✅ 验证安装**
|
||
安装后，打开 **Claude Code** 并通过运行以下命令检查工作流命令是否可用：
|
||
```bash
|
||
/workflow:session:list
|
||
```
|
||
如果斜杠命令（例如 `/workflow:*`）被识别，则表示安装成功。
|
||
|
||
---
|
||
|
||
## 🛠️ 命令参考
|
||
|
||
CCW 提供了一套丰富的命令，用于管理工作流、任务以及与 AI 工具的交互。有关所有可用命令的完整列表和详细说明，请参阅 [**COMMAND_REFERENCE.md**](COMMAND_REFERENCE.md) 文件。
|
||
|
||
有关每个命令的详细技术规范，请参阅 [**COMMAND_SPEC.md**](COMMAND_SPEC.md)。
|
||
|
||
---
|
||
|
||
### 💡 **需要帮助？使用交互式命令指南**
|
||
|
||
CCW 包含内置的**命令指南技能**，帮助您有效地发现和使用命令：
|
||
|
||
- **`CCW-help`** - 获取交互式帮助和命令推荐
|
||
- **`CCW-issue`** - 使用引导模板报告错误或请求功能
|
||
|
||
命令指南提供：
|
||
- 🔍 **智能命令搜索** - 按关键词、分类或使用场景查找命令
|
||
- 🤖 **下一步推荐** - 获取任何命令之后的操作建议
|
||
- 📖 **详细文档** - 查看参数、示例和最佳实践
|
||
- 🎓 **新手入门** - 通过引导式学习路径学习 14 个核心命令
|
||
- 📝 **问题报告** - 生成标准化的错误报告和功能请求
|
||
|
||
**使用示例**:
|
||
```
|
||
用户: "CCW-help"
|
||
→ 交互式菜单，包含命令搜索、推荐和文档
|
||
|
||
用户: "执行完 /workflow:plan 后做什么？"
|
||
→ 推荐 /workflow:execute、/workflow:action-plan-verify 及工作流模式
|
||
|
||
用户: "CCW-issue"
|
||
→ 引导式模板生成，用于错误、功能或问题咨询
|
||
```
|
||
|
||
---
|
||
|
||
## 🚀 快速入门
|
||
|
||
开始使用的最佳方式是遵循 [**快速上手指南**](GETTING_STARTED_CN.md) 中的 5 分钟教程。
|
||
|
||
以下是一个常见开发工作流的快速示例：
|
||
|
||
### **选项 1: Lite-Plan 工作流** (⚡ 推荐用于快速任务)
|
||
|
||
轻量级交互式工作流，内存中规划并立即执行：
|
||
|
||
```bash
|
||
# 基本用法，自动检测
|
||
/workflow:lite-plan "为用户登录添加 JWT 认证"
|
||
|
||
# 强制代码探索
|
||
/workflow:lite-plan -e "重构日志模块以提高性能"
|
||
|
||
# 基本用法
|
||
/workflow:lite-plan "为认证服务添加单元测试"
|
||
```
|
||
|
||
**交互流程**:
|
||
1. **阶段 1**: 自动任务分析和智能代码探索（如需要）
|
||
2. **阶段 2**: 回答澄清问题（如有）
|
||
3. **阶段 3**: 查看生成的计划和任务分解
|
||
4. **阶段 4**: 三维确认:
|
||
- ✅ 确认/修改/取消任务
|
||
- 🔧 选择执行方式: 智能体 / 仅提供计划 / CLI（Gemini/Qwen/Codex）
|
||
- 🔍 可选代码审查: 否 / Claude / Gemini / Qwen / Codex
|
||
5. **阶段 5**: 观察实时执行和任务跟踪
|
||
|
||
### **选项 2: 完整工作流** (综合规划)
|
||
|
||
适用于复杂项目的传统多阶段工作流：
|
||
|
||
1. **创建计划**（自动启动会话）:
|
||
```bash
|
||
/workflow:plan "实现基于 JWT 的用户登录和注册"
|
||
```
|
||
2. **执行计划**:
|
||
```bash
|
||
/workflow:execute
|
||
```
|
||
3. **查看状态**（可选）:
|
||
```bash
|
||
/workflow:status
|
||
```
|
||
|
||
---
|
||
|
||
## 📚 文档
|
||
|
||
CCW 提供全面的文档，帮助您快速上手并掌握高级功能：
|
||
|
||
### 📖 **快速入门**
|
||
- [**快速上手指南**](GETTING_STARTED_CN.md) - 5 分钟快速入门教程
|
||
- [**安装指南**](INSTALL_CN.md) - 详细安装说明 ([English](INSTALL.md))
|
||
- [**工作流决策指南**](WORKFLOW_DECISION_GUIDE.md) - 🌳 交互式流程图帮助选择正确的命令
|
||
- [**示例**](EXAMPLES.md) - 真实世界用例和实践示例 (English)
|
||
- [**常见问题**](FAQ.md) - 常见问题和故障排除 (English)
|
||
|
||
### 🏗️ **架构与设计**
|
||
- [**架构概览**](ARCHITECTURE.md) - 系统设计和核心组件 (English)
|
||
- [**项目介绍**](PROJECT_INTRODUCTION.md) - 详细项目概览
|
||
- [**工作流图示**](WORKFLOW_DIAGRAMS.md) - 可视化工作流表示 (English)
|
||
|
||
### 📋 **命令参考**
|
||
- [**命令参考**](COMMAND_REFERENCE.md) - 所有命令的完整列表 (English)
|
||
- [**命令规范**](COMMAND_SPEC.md) - 详细技术规范 (English)
|
||
- [**命令流程标准**](COMMAND_FLOW_STANDARD.md) - 命令设计模式 (English)
|
||
|
||
### 🤝 **贡献**
|
||
- [**贡献指南**](CONTRIBUTING.md) - 如何为 CCW 做贡献 (English)
|
||
- [**更新日志**](CHANGELOG.md) - 版本历史和发布说明
|
||
|
||
---
|
||
|
||
## 🤝 贡献与支持
|
||
|
||
- **仓库**: [GitHub - Claude-Code-Workflow](https://github.com/catlog22/Claude-Code-Workflow)
|
||
- **问题**: 在 [GitHub Issues](https://github.com/catlog22/Claude-Code-Workflow/issues) 上报告错误或请求功能。
|
||
- **讨论**: 加入 [社区论坛](https://github.com/catlog22/Claude-Code-Workflow/discussions)。
|
||
- **贡献**: 查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解贡献指南。
|
||
|
||
## 📄 许可证
|
||
|
||
此项目根据 **MIT 许可证** 授权。详见 [LICENSE](LICENSE) 文件。 |