mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-01 15:03:57 +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:
catlog22
@@ -50,32 +50,24 @@
|
||||
|
||||
## 1.4 Architecture Overview
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Claude_dms3 Architecture │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
|
||||
│ │ CodexLens │ │ CCW │ │ Memory │ │
|
||||
│ │ (Semantic │ │ (CLI Call │ │ (Persistent │ │
|
||||
│ │ Index) │ │ Framework) │ │ Context) │ │
|
||||
│ └──────┬──────┘ └──────┬──────┘ └──────┬──────┘ │
|
||||
│ │ │ │ │
|
||||
│ └────────────────┼────────────────┘ │
|
||||
│ │ │
|
||||
│ ┌─────┴─────┐ │
|
||||
│ │ Spec │ │
|
||||
│ │ System │ │
|
||||
│ └─────┬─────┘ │
|
||||
│ │ │
|
||||
│ ┌────────────────┼────────────────┐ │
|
||||
│ │ │ │ │
|
||||
│ ┌────┴────┐ ┌─────┴─────┐ ┌────┴────┐ │
|
||||
│ │ Hooks │ │ Skills │ │ Agents │ │
|
||||
│ │(Inject) │ │(Reusable) │ │(Roles) │ │
|
||||
│ └─────────┘ └───────────┘ └─────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph Claude_dms3_Architecture[Claude_dms3 Architecture]
|
||||
A[CodexLens<br/>Semantic Index]
|
||||
B[CCW<br/>CLI Call Framework]
|
||||
C[Memory<br/>Persistent Context]
|
||||
D[Spec System]
|
||||
E[Hooks<br/>Inject]
|
||||
F[Skills<br/>Reusable]
|
||||
G[Agents<br/>Roles]
|
||||
|
||||
A --> D
|
||||
B --> D
|
||||
C --> D
|
||||
D --> E
|
||||
D --> F
|
||||
D --> G
|
||||
end
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@@ -20,8 +20,8 @@
|
||||
### 2.1.2 Clone Project
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://github.com/your-repo/claude-dms3.git
|
||||
# Clone repository (replace with your fork or the actual repository URL)
|
||||
git clone https://github.com/[username]/claude-dms3.git
|
||||
cd claude-dms3
|
||||
|
||||
# Install dependencies
|
||||
@@ -30,24 +30,38 @@ npm install
|
||||
|
||||
### 2.1.3 Configure API Keys
|
||||
|
||||
Configure API Keys in `~/.claude/settings.json`:
|
||||
Configure API Keys in `~/.claude/cli-tools.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"openai": {
|
||||
"apiKey": "sk-xxx"
|
||||
},
|
||||
"anthropic": {
|
||||
"apiKey": "sk-ant-xxx"
|
||||
},
|
||||
"google": {
|
||||
"apiKey": "AIza-xxx"
|
||||
"tools": {
|
||||
"gemini": {
|
||||
"enabled": true,
|
||||
"primaryModel": "gemini-2.5-flash",
|
||||
"settings": {
|
||||
"apiKey": "AIza-xxx"
|
||||
}
|
||||
},
|
||||
"claude": {
|
||||
"enabled": true,
|
||||
"primaryModel": "sonnet",
|
||||
"settings": {
|
||||
"apiKey": "sk-ant-xxx"
|
||||
}
|
||||
},
|
||||
"codex": {
|
||||
"enabled": true,
|
||||
"primaryModel": "gpt-5.2",
|
||||
"settings": {
|
||||
"apiKey": "sk-xxx"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
::: tip Tip
|
||||
API Keys can also be configured at the project level in `.claude/settings.json`. Project-level configuration takes priority over global configuration.
|
||||
API Keys can also be configured at the project level in `.claude/cli-tools.json`. Project-level configuration takes priority over global configuration.
|
||||
:::
|
||||
|
||||
---
|
||||
@@ -225,8 +239,8 @@ Or use Command Palette (Ctrl+Shift+P) and search "CCW Dashboard".
|
||||
**Q: Where to configure API Keys?**
|
||||
|
||||
A: Can be configured in two locations:
|
||||
- Global configuration: `~/.claude/settings.json`
|
||||
- Project configuration: `.claude/settings.json`
|
||||
- Global configuration: `~/.claude/cli-tools.json`
|
||||
- Project configuration: `.claude/cli-tools.json`
|
||||
|
||||
Project configuration takes priority over global configuration.
|
||||
|
||||
@@ -258,15 +272,15 @@ A: Select based on task objective:
|
||||
### Installation Steps
|
||||
|
||||
```bash
|
||||
# 1. Clone project
|
||||
git clone https://github.com/your-repo/claude-dms3.git
|
||||
# 1. Clone project (replace with your fork or the actual repository URL)
|
||||
git clone https://github.com/[username]/claude-dms3.git
|
||||
cd claude-dms3
|
||||
|
||||
# 2. Install dependencies
|
||||
npm install
|
||||
|
||||
# 3. Configure API Keys
|
||||
# Edit ~/.claude/settings.json
|
||||
# Edit ~/.claude/cli-tools.json
|
||||
|
||||
# 4. Start workflow session
|
||||
/workflow:session:start
|
||||
|
||||
@@ -66,29 +66,15 @@ Codex Prompts are defined in the `.codex/prompts/` directory, optimized specific
|
||||
|
||||
## 3.2 Three-Layer Relationship
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ User Request │
|
||||
└────────────────────┬────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ ccw (Orchestrator) │
|
||||
│ Intent Analysis → Workflow Selection → Execution │
|
||||
└────────────────────┬────────────────────────────────┘
|
||||
│
|
||||
┌───────────┼───────────┐
|
||||
▼ ▼ ▼
|
||||
┌────────┐ ┌────────┐ ┌────────┐
|
||||
│ Command│ │ Skill │ │ Prompt │
|
||||
│ (Atom) │ │(Composite)│ │(Template)│
|
||||
└────────┘ └────────┘ └────────┘
|
||||
│ │ │
|
||||
└───────────┼───────────┘
|
||||
▼
|
||||
┌────────────────┐
|
||||
│ AI Model Call │
|
||||
└────────────────┘
|
||||
```mermaid
|
||||
graph TB
|
||||
A[User Request] --> B[ccw Orchestrator<br/>Intent Analysis → Workflow Selection → Execution]
|
||||
B --> C[Command Atom]
|
||||
B --> D[Skill Composite]
|
||||
B --> E[Prompt Template]
|
||||
C --> F[AI Model Call]
|
||||
D --> F
|
||||
E --> F
|
||||
```
|
||||
|
||||
### 3.2.1 Call Path
|
||||
@@ -107,17 +93,13 @@ Codex Prompts are defined in the `.codex/prompts/` directory, optimized specific
|
||||
|
||||
### 3.3.1 Session Lifecycle
|
||||
|
||||
```
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
|
||||
│ Start │────▶│ Resume │────▶│ Execute │────▶│Complete │
|
||||
│ Launch │ │ Resume │ │ Execute │ │ Complete│
|
||||
└─────────┘ └─────────┘ └─────────┘ └─────────┘
|
||||
│ │
|
||||
▼ ▼
|
||||
┌─────────┐ ┌─────────┐
|
||||
│ List │ │ Solidify│
|
||||
│ List │ │ Solidify│
|
||||
└─────────┘ └─────────┘
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Start<br/>Launch] --> B[Resume<br/>Resume]
|
||||
B --> C[Execute<br/>Execute]
|
||||
C --> D[Complete<br/>Complete]
|
||||
A --> E[List<br/>List]
|
||||
D --> F[Solidify<br/>Solidify]
|
||||
```
|
||||
|
||||
### 3.3.2 Session Commands
|
||||
@@ -172,20 +154,11 @@ Claude_dms3 supports 8 team workflows, each defining different roles:
|
||||
|
||||
Team members communicate via the message bus:
|
||||
|
||||
```
|
||||
┌────────────┐ ┌────────────┐
|
||||
│ 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 Workflow Selection Guide
|
||||
@@ -221,38 +194,25 @@ Team members communicate via the message bus:
|
||||
|
||||
## 3.6 Data Flow
|
||||
|
||||
```
|
||||
User Request
|
||||
│
|
||||
▼
|
||||
┌──────────────┐
|
||||
│ CCW Orchestrator│ ──▶ Intent Analysis
|
||||
└──────────────┘
|
||||
│
|
||||
├─▶ Workflow Selection
|
||||
│ │
|
||||
│ ├─▶ PlanEx
|
||||
│ ├─▶ IterDev
|
||||
│ ├─▶ Lifecycle
|
||||
│ └─▶ ...
|
||||
│
|
||||
├─▶ Command Execution
|
||||
│ │
|
||||
│ ├─▶ Built-in commands
|
||||
│ └─▶ Skill calls
|
||||
│
|
||||
├─▶ AI Model Invocation
|
||||
│ │
|
||||
│ ├─▶ Gemini
|
||||
│ ├─▶ Qwen
|
||||
│ ├─▶ Codex
|
||||
│ └─▶ Claude
|
||||
│
|
||||
└─▶ Result Return
|
||||
│
|
||||
├─▶ File modification
|
||||
├─▶ Memory update
|
||||
└─▶ Dashboard update
|
||||
```mermaid
|
||||
graph TB
|
||||
A[User Request] --> B[CCW Orchestrator<br/>Intent Analysis]
|
||||
B --> C[Workflow Selection]
|
||||
B --> D[Command Execution]
|
||||
B --> E[AI Model Invocation]
|
||||
B --> F[Result Return]
|
||||
C --> C1[PlanEx]
|
||||
C --> C2[IterDev]
|
||||
C --> C3[Lifecycle]
|
||||
D --> D1[Built-in commands]
|
||||
D --> D2[Skill calls]
|
||||
E --> E1[Gemini]
|
||||
E --> E2[Qwen]
|
||||
E --> E3[Codex]
|
||||
E --> E4[Claude]
|
||||
F --> F1[File modification]
|
||||
F --> F2[Memory update]
|
||||
F --> F3[Dashboard update]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@@ -29,31 +29,26 @@
|
||||
|
||||
### 4.2.2 Launch Method
|
||||
|
||||
```
|
||||
```shell
|
||||
/workflow:plan
|
||||
```
|
||||
|
||||
Or describe requirements directly:
|
||||
|
||||
```
|
||||
```plaintext
|
||||
Implement user login functionality, supporting email and phone number login
|
||||
```
|
||||
|
||||
### 4.2.3 Workflow Process
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Planner │────▶│ Executor │────▶│ Reviewer │
|
||||
│ Planning │ │ Execution │ │ Review │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘
|
||||
│ │ │
|
||||
▼ ▼ ▼
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Requirements│ │ Task │ │ Code │
|
||||
│ Analysis │ │ Execution │ │ Review │
|
||||
│ Task Breakdown│ Code Gen │ │ Quality │
|
||||
│ Plan Gen │ │ Test Write │ │ Feedback │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Planner<br/>Planning] -->|plan_ready| B[Executor<br/>Execution]
|
||||
B -->|task_complete| C[Reviewer<br/>Review]
|
||||
|
||||
A --> A1[Requirements Analysis<br/>Task Breakdown<br/>Plan Gen]
|
||||
B --> B1[Task Execution<br/>Code Gen<br/>Test Write]
|
||||
C --> C1[Code Review<br/>Quality Check<br/>Feedback]
|
||||
```
|
||||
|
||||
### 4.2.4 Output Artifacts
|
||||
@@ -75,26 +70,20 @@ Implement user login functionality, supporting email and phone number login
|
||||
|
||||
### 4.3.2 Launch Method
|
||||
|
||||
```
|
||||
```shell
|
||||
/refactor-cycle
|
||||
```
|
||||
|
||||
### 4.3.3 Workflow Process
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Discover │────▶│ Plan │────▶│ Refactor │
|
||||
│ Discovery │ │ Planning │ │ Refactoring │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘
|
||||
│ │ │
|
||||
▼ ▼ ▼
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Code │ │ Refactor │ │ Code │
|
||||
│ Analysis │ │ Strategy │ │ Modification│
|
||||
│ Problem │ │ Priority │ │ Test │
|
||||
│ ID │ │ Task Breakdown│ │ Verification│
|
||||
│ Tech Debt │ │ │ │ Doc Update │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Discover<br/>Discovery] -->|discoveries| B[Plan<br/>Planning]
|
||||
B -->|plan| C[Refactor<br/>Refactoring]
|
||||
|
||||
A --> A1[Code Analysis<br/>Problem ID<br/>Tech Debt]
|
||||
B --> B1[Refactor Strategy<br/>Priority<br/>Task Breakdown]
|
||||
C --> C1[Code Modification<br/>Test Verification<br/>Doc Update]
|
||||
```
|
||||
|
||||
### 4.3.4 Use Cases
|
||||
@@ -117,7 +106,7 @@ Implement user login functionality, supporting email and phone number login
|
||||
|
||||
### 4.4.2 Launch Method
|
||||
|
||||
```
|
||||
```shell
|
||||
/unified-execute-with-file <file>
|
||||
```
|
||||
|
||||
@@ -132,17 +121,16 @@ Implement user login functionality, supporting email and phone number login
|
||||
|
||||
### 4.4.4 Workflow Process
|
||||
|
||||
```
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
|
||||
│Analyzer │──▶│Developer│──▶│ Tester │──▶│Reviewer │
|
||||
│ Analysis │ │ Develop │ │ Test │ │ Review │
|
||||
└─────────┘ └─────────┘ └─────────┘ └─────────┘
|
||||
│ │ │ │
|
||||
▼ ▼ ▼ ▼
|
||||
Requirement Code Test Quality
|
||||
Analysis Implementation Verification Gate
|
||||
Code Unit Regression Final
|
||||
Exploration Test Test Confirmation
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Analyzer<br/>Analysis] --> B[Developer<br/>Develop]
|
||||
B --> C[Tester<br/>Test]
|
||||
C --> D[Reviewer<br/>Review]
|
||||
|
||||
A --> A1[Requirement Analysis<br/>Code Exploration]
|
||||
B --> B1[Code Implementation<br/>Unit Test]
|
||||
C --> C1[Test Verification<br/>Regression Test]
|
||||
D --> D1[Quality Gate<br/>Final Confirmation]
|
||||
```
|
||||
|
||||
---
|
||||
@@ -166,17 +154,16 @@ Implement user login functionality, supporting email and phone number login
|
||||
|
||||
### 4.5.3 Workflow Process
|
||||
|
||||
```
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
|
||||
│Discover │──▶│ Plan │──▶│ Queue │──▶│ Execute │
|
||||
│Discovery│ │ Plan │ │ Queue │ │ Execute │
|
||||
└─────────┘ └─────────┘ └─────────┘ └─────────┘
|
||||
│ │ │ │
|
||||
▼ ▼ ▼ ▼
|
||||
Identify Analyze Priority Implement
|
||||
Problems Requirements Sort Solution
|
||||
Define Plan Dependencies Verify
|
||||
Scope Results
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Discover<br/>Discovery] -->|issues| B[Plan<br/>Plan]
|
||||
B -->|plan| C[Queue<br/>Queue]
|
||||
C -->|queue| D[Execute<br/>Execute]
|
||||
|
||||
A --> A1[Identify Problems<br/>Define Scope]
|
||||
B --> B1[Analyze Requirements<br/>Create Plan]
|
||||
C --> C1[Priority Sort<br/>Dependencies]
|
||||
D --> D1[Implement Solution<br/>Verify Results]
|
||||
```
|
||||
|
||||
---
|
||||
@@ -189,22 +176,20 @@ Implement user login functionality, supporting email and phone number login
|
||||
|
||||
### 4.6.2 Launch Method
|
||||
|
||||
```
|
||||
```shell
|
||||
/integration-test-cycle
|
||||
```
|
||||
|
||||
### 4.6.3 Workflow Process
|
||||
|
||||
```
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐
|
||||
│Generate │──▶│ Execute │──▶│ Verify │
|
||||
│ Generate │ │ Execute │ │ Verify │
|
||||
└─────────┘ └─────────┘ └─────────┘
|
||||
│ │ │
|
||||
▼ ▼ ▼
|
||||
Test Cases Run Tests Coverage
|
||||
Mock Data Failure Analysis
|
||||
Analysis Gap Fill
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Generate<br/>Generate] --> B[Execute<br/>Execute]
|
||||
B --> C[Verify<br/>Verify]
|
||||
|
||||
A --> A1[Test Cases<br/>Mock Data]
|
||||
B --> B1[Run Tests<br/>Failure Analysis]
|
||||
C --> C1[Coverage Analysis<br/>Gap Fill]
|
||||
```
|
||||
|
||||
---
|
||||
@@ -217,7 +202,7 @@ Implement user login functionality, supporting email and phone number login
|
||||
|
||||
### 4.7.2 Launch Method
|
||||
|
||||
```
|
||||
```shell
|
||||
/review-cycle
|
||||
```
|
||||
|
||||
@@ -242,7 +227,7 @@ Implement user login functionality, supporting email and phone number login
|
||||
|
||||
### 4.8.2 Launch Method
|
||||
|
||||
```
|
||||
```shell
|
||||
/brainstorm-with-file <file>
|
||||
```
|
||||
|
||||
|
||||
@@ -68,15 +68,16 @@ Examples:
|
||||
|
||||
### 6.2.2 Review Process
|
||||
|
||||
```
|
||||
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
|
||||
│ Submit │──▶│ Review │──▶│ Feedback│──▶│ Fix │
|
||||
│ Code │ │ Code │ │ Comments│ │ Issues │
|
||||
└─────────┘ └─────────┘ └─────────┘ └─────────┘
|
||||
│ │ │ │
|
||||
▼ ▼ ▼ ▼
|
||||
Push PR Auto Review Manual Review Fix Verify
|
||||
CI Check 6 Dimensions Code Walkthrough Re-review
|
||||
```mermaid
|
||||
graph LR
|
||||
A[Submit Code] --> B[Review Code]
|
||||
B --> C[Feedback Comments]
|
||||
C --> D[Fix Issues]
|
||||
|
||||
A --> A1[Push PR<br/>CI Check]
|
||||
B --> B1[Auto Review<br/>6 Dimensions]
|
||||
C --> C1[Manual Review<br/>Code Walkthrough]
|
||||
D --> D1[Fix Verify<br/>Re-review]
|
||||
```
|
||||
|
||||
### 6.2.3 Review Checklist
|
||||
|
||||
Reference in New Issue
Block a user