catlog22/Claude-Code-Workflow
1
0
Fork 0
mirror of https://github.com/catlog22/Claude-Code-Workflow.git synced 2026-03-01 15:03:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refactor documentation for code commands and workflows

Browse Source 
- Updated command syntax formatting to use code blocks for clarity in `prep.md`, `review.md`, and `spec.md`.
- Enhanced architectural diagrams in `ch01-what-is-claude-dms3.md` and core concepts in `ch03-core-concepts.md` using mermaid syntax for better visualization.
- Improved workflow diagrams in `ch04-workflow-basics.md` and `4-level.md` to provide clearer representations of processes.
- Added troubleshooting section in `installation.md` to address common installation issues and provide quick start examples.
- Revised skill documentation in `claude-meta.md` and `claude-workflow.md` to standardize command triggers and output structures.
- Updated best practices and workflow index documentation to enhance readability and understanding of workflow levels and practices.
This commit is contained in:
catlog22
2026-02-28 19:53:24 +08:00
parent b0bfdb907a
commit 4a89f626fc
51 changed files with 741 additions and 619 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/zh/guide/ch01-what-is-claude-dms3.md
View File

@@ -50,32 +50,24 @@
## 1.4 架构概览
```
┌─────────────────────────────────────────────────────────────┐
│ Claude_dms3 架构 │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
│ │ CodexLens │ │ CCW │ │ Memory │ │
│ │ (语义索引) │ │ (CLI调用 │ │ (持久化 │ │
│ │ │ │ 框架) │ │ 上下文) │ │
│ └──────┬──────┘ └──────┬──────┘ └──────┬──────┘ │
│ │ │ │ │
│ └────────────────┼────────────────┘ │
│ │ │
│ ┌─────┴─────┐ │
│ │ Spec │ │
│ │ 规范系统 │ │
│ └─────┬─────┘ │
│ │ │
│ ┌────────────────┼────────────────┐ │
│ │ │ │ │
│ ┌────┴────┐ ┌─────┴─────┐ ┌────┴────┐ │
│ │ Hooks │ │ Skills │ │ Agents │ │
│ │ (注入) │ │ (可复用) │ │ (角色) │ │
│ └─────────┘ └───────────┘ └─────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```mermaid
graph TB
subgraph Claude_dms3_Architecture[Claude_dms3 架构]
A[CodexLens<br/>语义索引]
B[CCW<br/>CLI调用框架]
C[Memory<br/>持久化上下文]
D[Spec 规范系统]
E[Hooks<br/>注入]
F[Skills<br/>可复用]
G[Agents<br/>角色]
A --> D
B --> D
C --> D
D --> E
D --> F
D --> G
end
```
---

120
docs/zh/guide/ch03-core-concepts.md
View File

@@ -66,29 +66,15 @@ Codex Prompts 定义在 `.codex/prompts/` 目录，专为 Codex 模型优化。
## 3.2 三层关系
```
┌─────────────────────────────────────────────────────┐
│ 用户请求 │
└────────────────────┬────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────┐
│ ccw (编排器) │
│ 意图分析 → 工作流选择 → 命令链执行 │
└────────────────────┬────────────────────────────────┘
│
┌───────────┼───────────┐
▼ ▼ ▼
┌────────┐ ┌────────┐ ┌────────┐
│ Command│ │ Skill │ │ Prompt │
│ (原子) │ │ (复合) │ │(模板) │
└────────┘ └────────┘ └────────┘
│ │ │
└───────────┼───────────┘
▼
┌────────────────┐
│ AI 模型调用 │
└────────────────┘
```mermaid
graph TB
A[用户请求] --> B[ccw 编排器<br/>意图分析 → 工作流选择 → 命令链执行]
B --> C[Command 原子]
B --> D[Skill 复合]
B --> E[Prompt 模板]
C --> F[AI 模型调用]
D --> F
E --> F
```
### 3.2.1 调用路径
@@ -107,17 +93,13 @@ Codex Prompts 定义在 `.codex/prompts/` 目录，专为 Codex 模型优化。
### 3.3.1 会话生命周期
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ Start │────▶│ Resume │────▶│ Execute │────▶│Complete │
│ 启动 │ │ 恢复 │ │ 执行 │ │ 完成 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │
▼ ▼
┌─────────┐ ┌─────────┐
│ List │ │ Solidify│
│ 列出 │ │ 固化 │
└─────────┘ └─────────┘
```mermaid
graph LR
A[Start<br/>启动] --> B[Resume<br/>恢复]
B --> C[Execute<br/>执行]
C --> D[Complete<br/>完成]
A --> E[List<br/>列出]
D --> F[Solidify<br/>固化]
```
### 3.3.2 会话命令
@@ -172,20 +154,11 @@ Claude_dms3 支持 8 种团队工作流，每种工作流定义了不同的角
团队成员通过消息总线通信：
```
┌────────────┐ ┌────────────┐
│ Planner │ │ Executor │
└─────┬──────┘ └──────┬─────┘
│ │
│ [plan_ready] │
├────────────────────────────────▶
│ │
│ [task_complete]
│◀────────────────────────────────┤
│ │
│ [plan_approved] │
├────────────────────────────────▶
│ │
```mermaid
graph LR
A[Planner] -->|plan_ready| B[Executor]
B -->|task_complete| A
A -->|plan_approved| B
```
### 3.4.3 工作流选择指南
@@ -221,38 +194,25 @@ Claude_dms3 支持 8 种团队工作流，每种工作流定义了不同的角
## 3.6 数据流
```
用户请求
│
▼
┌──────────────┐
│ CCW 编排器 │ ──▶ 意图分析
└──────────────┘
│
├─▶ Workflow 选择
│ │
│ ├─▶ PlanEx
│ ├─▶ IterDev
│ ├─▶ Lifecycle
│ └─▶ ...
│
├─▶ Command 执行
│ │
│ ├─▶ 内置命令
│ └─▶ Skill 调用
│
├─▶ AI 模型调用
│ │
│ ├─▶ Gemini
│ ├─▶ Qwen
│ ├─▶ Codex
│ └─▶ Claude
│
└─▶ 结果返回
│
├─▶ 文件修改
├─▶ Memory 更新
└─▶ Dashboard 更新
```mermaid
graph TB
A[用户请求] --> B[CCW 编排器<br/>意图分析]
B --> C[Workflow 选择]
B --> D[Command 执行]
B --> E[AI 模型调用]
B --> F[结果返回]
C --> C1[PlanEx]
C --> C2[IterDev]
C --> C3[Lifecycle]
D --> D1[内置命令]
D --> D2[Skill 调用]
E --> E1[Gemini]
E --> E2[Qwen]
E --> E3[Codex]
E --> E4[Claude]
F --> F1[文件修改]
F --> F2[Memory 更新]
F --> F3[Dashboard 更新]
```
---

109
docs/zh/guide/ch04-workflow-basics.md
View File

@@ -29,30 +29,26 @@
### 4.2.2 启动方式
```
```shell
/workflow:plan
```
或直接描述需求：
```
```plaintext
实现用户登录功能，支持邮箱和手机号登录
```
### 4.2.3 工作流程
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ Planner │────▶│ Executor │────▶│ Reviewer │
│ 规划阶段 │ │ 执行阶段 │ │ 审查阶段 │
└─────────────┘ └─────────────┘ └─────────────┘
│ │ │
▼ ▼ ▼
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ 需求分析 │ │ 任务执行 │ │ 代码审查 │
│ 任务分解 │ │ 代码生成 │ │ 质量检查 │
│ 计划生成 │ │ 测试编写 │ │ 反馈修复 │
└─────────────┘ └─────────────┘ └─────────────┘
```mermaid
graph LR
A[Planner<br/>规划阶段] -->|plan_ready| B[Executor<br/>执行阶段]
B -->|task_complete| C[Reviewer<br/>审查阶段]
A --> A1[需求分析<br/>任务分解<br/>计划生成]
B --> B1[任务执行<br/>代码生成<br/>测试编写]
C --> C1[代码审查<br/>质量检查<br/>反馈修复]
```
### 4.2.4 输出产物
@@ -74,24 +70,20 @@
### 4.3.2 启动方式
```
```shell
/refactor-cycle
```
### 4.3.3 工作流程
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ Discover │────▶│ Plan │────▶│ Refactor │
│ 发现阶段 │ │ 规划阶段 │ │ 重构阶段 │
└─────────────┘ └─────────────┘ └─────────────┘
│ │ │
▼ ▼ ▼
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ 代码分析 │ │ 重构策略 │ │ 代码修改 │
│ 问题识别 │ │ 优先级排序 │ │ 测试验证 │
│ 技术债记录 │ │ 任务分解 │ │ 文档更新 │
└─────────────┘ └─────────────┘ └─────────────┘
```mermaid
graph LR
A[Discover<br/>发现阶段] -->|discoveries| B[Plan<br/>规划阶段]
B -->|plan| C[Refactor<br/>重构阶段]
A --> A1[代码分析<br/>问题识别<br/>技术债记录]
B --> B1[重构策略<br/>优先级排序<br/>任务分解]
C --> C1[代码修改<br/>测试验证<br/>文档更新]
```
### 4.3.4 使用场景
@@ -114,7 +106,7 @@
### 4.4.2 启动方式
```
```shell
/unified-execute-with-file <file>
```
@@ -129,15 +121,16 @@
### 4.4.4 工作流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│Analyzer │──▶│Developer│──▶│ Tester │──▶│Reviewer │
│ 分析 │ │ 开发 │ │ 测试 │ │ 审查 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ │ │
▼ ▼ ▼ ▼
需求分析 代码实现 测试验证 质量把关
代码探索 单元测试 回归测试 最终确认
```mermaid
graph LR
A[Analyzer<br/>分析] --> B[Developer<br/>开发]
B --> C[Tester<br/>测试]
C --> D[Reviewer<br/>审查]
A --> A1[需求分析<br/>代码探索]
B --> B1[代码实现<br/>单元测试]
C --> C1[测试验证<br/>回归测试]
D --> D1[质量把关<br/>最终确认]
```
---
@@ -161,15 +154,16 @@
### 4.5.3 工作流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│Discover │──▶│ Plan │──▶│ Queue │──▶│ Execute │
│ 发现 │ │ 规划 │ │ 排队 │ │ 执行 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ │ │
▼ ▼ ▼ ▼
识别问题 分析需求 优先级排序 实现方案
定义范围 制定计划 依赖关系 验证结果
```mermaid
graph LR
A[Discover<br/>发现] -->|issues| B[Plan<br/>规划]
B -->|plan| C[Queue<br/>排队]
C -->|queue| D[Execute<br/>执行]
A --> A1[识别问题<br/>定义范围]
B --> B1[分析需求<br/>制定计划]
C --> C1[优先级排序<br/>依赖关系]
D --> D1[实现方案<br/>验证结果]
```
---
@@ -182,21 +176,20 @@
### 4.6.2 启动方式
```
```shell
/integration-test-cycle
```
### 4.6.3 工作流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐
│Generate │──▶│ Execute │──▶│ Verify │
│ 生成 │ │ 执行 │ │ 验证 │
└─────────┘ └─────────┘ └─────────┘
│ │ │
▼ ▼ ▼
测试用例 运行测试 覆盖率分析
Mock 数据 失败分析 缺口补充
```mermaid
graph LR
A[Generate<br/>生成] --> B[Execute<br/>执行]
B --> C[Verify<br/>验证]
A --> A1[测试用例<br/>Mock 数据]
B --> B1[运行测试<br/>失败分析]
C --> C1[覆盖率分析<br/>缺口补充]
```
---
@@ -209,7 +202,7 @@
### 4.7.2 启动方式
```
```shell
/review-cycle
```
@@ -234,7 +227,7 @@
### 4.8.2 启动方式
```
```shell
/brainstorm-with-file <file>
```

19
docs/zh/guide/ch06-best-practices.md
View File

@@ -68,15 +68,16 @@
### 6.2.2 审查流程
```
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ 提交 │──▶│ 审查 │──▶│ 反馈 │──▶│ 修复 │
│ 代码 │ │ 代码 │ │ 意见 │ │ 问题 │
└─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ │ │
▼ ▼ ▼ ▼
Push PR 自动审查 人工审查 修复验证
CI 检查 6 维度检查 代码走查 再次审查
```mermaid
graph LR
A[提交代码] --> B[审查代码]
B --> C[反馈意见]
C --> D[修复问题]
A --> A1[Push PR<br/>CI检查]
B --> B1[自动审查<br/>6维度检查]
C --> C1[人工审查<br/>代码走查]
D --> D1[修复验证<br/>再次审查]
```
### 6.2.3 审查清单

72
docs/zh/guide/installation.md
View File

@@ -113,6 +113,78 @@ npm uninstall -g claude-code-workflow
rm -rf ~/.claude
```
## 故障排除
### 权限问题
如果遇到权限错误：
```bash
# 使用 sudo（不推荐）
sudo npm install -g claude-code-workflow
# 或修复 npm 权限（推荐）
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH
```
### PATH 问题
将 npm 全局 bin 添加到您的 PATH：
```bash
# 对于 bash/zsh
echo 'export PATH=$(npm config get prefix)/bin:$PATH' >> ~/.bashrc
# 对于 fish
echo 'set -gx PATH (npm config get prefix)/bin $PATH' >> ~/.config/fish/config.fish
```
::: info 下一步
安装完成后，查看[第一个工作流](./first-workflow.md)指南。
:::
## 快速开始示例
安装完成后，尝试以下命令验证一切正常：
```bash
# 1. 在您的项目中初始化
cd your-project
ccw init
# 2. 尝试简单的分析
ccw cli -p "分析项目结构" --tool gemini --mode analysis
# 3. 运行主编排器
/ccw "总结代码库架构"
# 4. 检查可用命令
ccw --help
```
### 预期输出
```
$ ccw --version
CCW v7.0.5
$ ccw init
✔ Created .claude/CLAUDE.md
✔ Created .ccw/workflows/
✔ Configuration complete
$ ccw cli -p "Analyze project" --tool gemini --mode analysis
Analyzing with Gemini...
✔ Analysis complete
```
### 常见首次使用问题
| 问题 | 解决方案 |
|-------|----------|
| `ccw: command not found` | 将 npm 全局 bin 添加到 PATH，或重新安装 |
| `Permission denied` | 使用 `sudo` 或修复 npm 权限 |
| `API key not found` | 在 `~/.claude/cli-tools.json` 中配置 API 密钥 |
| `Node version mismatch` | 更新到 Node.js >= 18.0.0 |