mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-09 02:24:11 +08:00
docs: Update README files to v2.0 with four-layer architecture and command system alignment
- Sync version numbers: README_CN.md v1.2 → v2.0 to match English version - Add four-layer architecture documentation with data flow and integration points - Remove duplicate content: Automated Test Generation sections and script entries - Standardize command syntax: /workflow:session:list and file naming conventions - Add issue management commands to English README for feature parity - Unify complexity management tables and workflow lifecycle descriptions - Fix file path inconsistencies: .task/impl-*.json and .active-[session] markers - Align v2.0 feature descriptions across both language versions Based on Gemini command system analysis revealing actual workflow connections, data flow patterns, and architectural layers for improved documentation accuracy. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
37
README.md
37
README.md
@@ -21,7 +21,6 @@
|
||||
### 🌟 Key Innovations
|
||||
|
||||
- **🔄 Enhanced Workflow Lifecycle**: Complete development cycle: Brainstorm → Plan → Verify → Execute → Test → Review
|
||||
- **🧪 Automated Test Generation**: Comprehensive test workflow creation with full coverage planning
|
||||
- **🧪 Automated Test Generation**: Comprehensive test workflow generation (`/workflow:test-gen`) with full coverage planning
|
||||
- **✅ Plan Verification System**: Pre-execution validation using dual Gemini/Codex analysis (`/workflow:plan-verify`)
|
||||
- **🎯 JSON-First Architecture**: Single source of truth with atomic session management
|
||||
@@ -82,14 +81,16 @@ graph TB
|
||||
MARKER --> WDIR
|
||||
```
|
||||
|
||||
### 🏛️ **Three-Pillar Foundation**
|
||||
### 🏛️ **Four-Layer Architecture**
|
||||
|
||||
| 🏗️ **JSON-First Data Model** | ⚡ **Atomic Session Management** | 🧩 **Adaptive Complexity** |
|
||||
|---|---|---|
|
||||
| Single source of truth | Marker-based session state | Auto-adjusts to project size |
|
||||
| Sub-millisecond queries | Zero-overhead switching | Simple → Medium → Complex |
|
||||
| Generated Markdown views | Conflict-free concurrency | Task limit enforcement |
|
||||
| Data consistency guaranteed | Instant context switching | Intelligent decomposition |
|
||||
CCW operates through four distinct architectural layers with defined responsibilities and data contracts:
|
||||
|
||||
| Layer | Components | Data Flow | Integration Points |
|
||||
|-------|------------|-----------|-------------------|
|
||||
| **🖥️ Interface Layer** | CLI Commands, Gemini/Codex/Qwen Wrappers | User input → Commands → Agents | External CLI tools, approval modes |
|
||||
| **📋 Session Layer** | `.active-[session]` markers, `workflow-session.json` | Session state → Task discovery | Atomic session switching |
|
||||
| **📊 Task/Data Layer** | `.task/impl-*.json`, hierarchy management | Task definitions → Agent execution | JSON-first model, generated views |
|
||||
| **🤖 Orchestration Layer** | Multi-agent coordination, dependency resolution | Agent outputs → Task updates | Intelligent execution flow |
|
||||
|
||||
---
|
||||
|
||||
@@ -112,13 +113,6 @@ Comprehensive test workflow creation:
|
||||
- **Agent Assignment**: Specialized test agents for different test types
|
||||
- **Dependency Mapping**: Test execution follows implementation dependency chains
|
||||
|
||||
### 🧪 **Automated Test Generation**
|
||||
Comprehensive test workflow creation:
|
||||
- **Implementation Analysis**: Scans completed IMPL-* tasks for test requirements
|
||||
- **Multi-layered Testing**: Unit, Integration, E2E, Performance, Security tests
|
||||
- **Agent Assignment**: Specialized test agents for different test types
|
||||
- **Dependency Mapping**: Test execution follows implementation dependency chains
|
||||
|
||||
### ✅ **Plan Verification System**
|
||||
Dual-engine validation before execution:
|
||||
- **Gemini Strategic Analysis**: High-level feasibility and architectural soundness
|
||||
@@ -221,6 +215,14 @@ CCW automatically adapts workflow structure based on project complexity:
|
||||
| `⚡ /task:execute` | Execute tasks with appropriate agents | `/task:execute task-id` |
|
||||
| `📋 /task:replan` | Replan tasks with detailed input | `/task:replan task-id ["text" \| file.md \| ISS-001]` |
|
||||
|
||||
#### 🏷️ Issue Management
|
||||
| Command | Function | Usage |
|
||||
|---------|----------|-------|
|
||||
| `➕ /workflow:issue:create` | Create new project issue | `/workflow:issue:create "API Rate Limiting" --priority=high` |
|
||||
| `📋 /workflow:issue:list` | List and filter issues | `/workflow:issue:list --status=open --assigned=system-architect` |
|
||||
| `📝 /workflow:issue:update` | Update existing issue | `/workflow:issue:update ISS-001 --status=in-progress` |
|
||||
| `✅ /workflow:issue:close` | Close completed issue | `/workflow:issue:close ISS-001 --reason=resolved` |
|
||||
|
||||
#### 🧠 Brainstorming Role Commands
|
||||
| Role | Command | Purpose |
|
||||
|------|---------|---------|
|
||||
@@ -339,8 +341,7 @@ graph LR
|
||||
├── 🔧 scripts/ # Automation utilities
|
||||
│ ├── 📊 gemini-wrapper # Intelligent Gemini wrapper
|
||||
│ ├── 🔧 get_modules_by_depth.sh # Project analysis
|
||||
│ ├── 📋 read-task-paths.sh # Task path conversion
|
||||
│ └── 🏗️ get_modules_by_depth.sh # Project analysis
|
||||
│ └── 📋 read-task-paths.sh # Task path conversion
|
||||
├── 🛠️ workflows/ # Core workflow documentation
|
||||
│ ├── 🏛️ workflow-architecture.md # System architecture
|
||||
│ ├── 📊 intelligent-tools-strategy.md # Tool selection guide
|
||||
@@ -398,7 +399,7 @@ Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/cat
|
||||
|
||||
### ✅ **Verify Installation**
|
||||
```bash
|
||||
/workflow:session list
|
||||
/workflow:session:list
|
||||
```
|
||||
|
||||
### ⚙️ **Essential Configuration**
|
||||
|
||||
Reference in New Issue
Block a user