mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-02 15:23:19 +08:00
Refactor documentation for code commands and workflows
- 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:
@@ -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>
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user