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:
@@ -4,7 +4,7 @@ The CCW 4-level workflow system provides a structured approach to software devel
|
||||
|
||||
## Overview
|
||||
|
||||
```
|
||||
```text
|
||||
Level 1: SPECIFICATION → Level 2: PLANNING → Level 3: IMPLEMENTATION → Level 4: VALIDATION
|
||||
```
|
||||
|
||||
@@ -38,7 +38,7 @@ Level 1: SPECIFICATION → Level 2: PLANNING → Level 3: IMPLEMENTATION → Lev
|
||||
|
||||
### Example Tasks
|
||||
|
||||
```
|
||||
```text
|
||||
RESEARCH-001 → DRAFT-001 → DRAFT-002 → DRAFT-003 → DRAFT-004 → QUALITY-001
|
||||
```
|
||||
|
||||
@@ -95,7 +95,7 @@ RESEARCH-001 → DRAFT-001 → DRAFT-002 → DRAFT-003 → DRAFT-004 → QUALITY
|
||||
|
||||
Tasks executed in topological order based on dependencies:
|
||||
|
||||
```
|
||||
```text
|
||||
TASK-001 (no deps) → TASK-002 (depends on 001) → TASK-003 (depends on 002)
|
||||
```
|
||||
|
||||
@@ -142,7 +142,7 @@ TASK-001 (no deps) → TASK-002 (depends on 001) → TASK-003 (depends on 002)
|
||||
|
||||
Event-driven execution with coordinator orchestration:
|
||||
|
||||
```
|
||||
```text
|
||||
Event Coordinator Workers
|
||||
────────────────────────────────────────────────
|
||||
callback/resume → handleCallback ─────────────────┐
|
||||
@@ -172,7 +172,7 @@ callback <───────────────────────
|
||||
|
||||
For simple linear successions, workers can spawn successors directly:
|
||||
|
||||
```
|
||||
```text
|
||||
[Worker A] complete
|
||||
→ Check: 1 ready task? simple successor?
|
||||
→ YES: Spawn Worker B directly
|
||||
@@ -183,7 +183,7 @@ For simple linear successions, workers can spawn successors directly:
|
||||
|
||||
Some epics can execute in parallel:
|
||||
|
||||
```
|
||||
```text
|
||||
EPIC-003: Content Modules ──┐
|
||||
├──→ EPIC-005: Interaction Features
|
||||
EPIC-004: Search & Nav ────┘
|
||||
|
||||
@@ -135,7 +135,7 @@ Optimize your CCW workflows for maximum efficiency and quality.
|
||||
|
||||
### Good Workflow
|
||||
|
||||
```
|
||||
```text
|
||||
[Specification]
|
||||
↓ Clear requirements with acceptance criteria
|
||||
[Planning]
|
||||
@@ -149,7 +149,7 @@ Optimize your CCW workflows for maximum efficiency and quality.
|
||||
|
||||
### Problematic Workflow
|
||||
|
||||
```
|
||||
```text
|
||||
[Specification]
|
||||
↓ Vague requirements, no acceptance criteria
|
||||
[Planning]
|
||||
|
||||
@@ -51,7 +51,7 @@ This is an output from `workflow:lite-plan` command.
|
||||
|
||||
### Execution Steps
|
||||
|
||||
```bash
|
||||
```shell
|
||||
# Execute the plan
|
||||
ccw workflow:execute --session WFS-001
|
||||
```
|
||||
|
||||
@@ -4,7 +4,7 @@ CCW's 4-level workflow system orchestrates the entire development lifecycle from
|
||||
|
||||
## Workflow Levels
|
||||
|
||||
```
|
||||
```text
|
||||
Level 1: SPECIFICATION
|
||||
↓
|
||||
Level 2: PLANNING
|
||||
@@ -90,8 +90,9 @@ Ensure quality.
|
||||
|
||||
```bash
|
||||
# Level 1: Specification
|
||||
Skill(skill="team-lifecycle-v4", args="Build user authentication system")
|
||||
Skill(skill="team-lifecycle-v5", args="Build user authentication system")
|
||||
# => Creates RESEARCH-001, DRAFT-001/002/003/004, QUALITY-001
|
||||
# Note: v5 is the latest version with team-worker architecture
|
||||
|
||||
# Level 2: Planning (auto-triggered after QUALITY-001)
|
||||
# => Creates PLAN-001 with task breakdown
|
||||
@@ -105,7 +106,7 @@ Skill(skill="team-lifecycle-v4", args="Build user authentication system")
|
||||
|
||||
## Workflow Visualization
|
||||
|
||||
```
|
||||
```text
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ WORKFLOW ORCHESTRATION │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
|
||||
@@ -127,7 +127,7 @@ The latest architecture uses the `team-worker` agent with dynamic role assignmen
|
||||
|
||||
### Wave Pipeline (team-planex)
|
||||
|
||||
```
|
||||
```text
|
||||
Wave 1: Plan ──────────────────────────────────┐
|
||||
↓ │
|
||||
Wave 2: Exec ←────────────────────────────────┘
|
||||
@@ -139,7 +139,7 @@ Concurrent planning and execution - executor works on wave N while planner plans
|
||||
|
||||
### Generator-Critic Loop (team-iterdev)
|
||||
|
||||
```
|
||||
```text
|
||||
Generator → Output → Critic → Feedback → Generator
|
||||
↓
|
||||
Integrator → Validator
|
||||
@@ -149,7 +149,7 @@ Iterative improvement through feedback cycles.
|
||||
|
||||
### CP-9 Dual-Track (team-uidesign)
|
||||
|
||||
```
|
||||
```text
|
||||
Design Track: Designer → Tokens → Style
|
||||
↓
|
||||
Implementation Track: Developer → Components
|
||||
@@ -161,7 +161,7 @@ Design and implementation proceed in parallel tracks.
|
||||
|
||||
### 5-Phase Lifecycle (team-lifecycle-v4)
|
||||
|
||||
```
|
||||
```text
|
||||
1. Spec Planning (coordinator + spec-lead)
|
||||
2. Architecture Design (architect)
|
||||
3. Implementation Planning (impl-lead + dev team)
|
||||
|
||||
Reference in New Issue
Block a user