Update README files to reflect v2.0 architecture upgrade

## Changes Made
- Add architecture v2.0 highlights with quantified benefits
- Update directory structure to show new core files
- Emphasize JSON-only data model and marker file session management
- Update complexity strategies with unified task-count thresholds
- Reference comprehensive upgrade documentation

## Key Updates
- JSON-only data model: Single source of truth with <1ms operations
- Marker file sessions: 95% performance improvement
- Progressive complexity: Unified thresholds (Simple <5, Medium 5-15, Complex >15)
- Architecture benefits: 40-50% maintenance reduction, 50% faster onboarding

## Documentation
- Link to WORKFLOW_SYSTEM_UPGRADE.md for detailed technical analysis
- Updated both English and Chinese README files
- Maintained consistency between language versions

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
catlog22
2025-09-08 17:09:44 +08:00
parent b84a57e769
commit c6c2b85617
2 changed files with 91 additions and 31 deletions

View File

@@ -8,20 +8,29 @@
A sophisticated multi-agent automation workflow framework that transforms complex software development tasks from conceptualization to implementation review into manageable, trackable, AI-orchestrated processes.
> **🎉 Major Architecture Upgrade (v2.0)**: Recently underwent comprehensive refactoring with **JSON-only data model**, **marker file session management**, and **unified complexity standards**. See [WORKFLOW_SYSTEM_UPGRADE.md](WORKFLOW_SYSTEM_UPGRADE.md) for details.
## 🏗️ Architecture Overview
Claude Code Workflow (CCW) is built on two foundational pillars:
Claude Code Workflow (CCW) is built on three foundational pillars:
### **Document-State Separation**
- **Documents (*.md)**: Store human-readable plans, strategies, analysis reports, and summaries
- **State (*.json)**: Manage machine-readable, dynamic workflow states and task definitions
- This separation ensures robustness, recoverability, and automated processing capabilities
### **JSON-Only Data Model**
- **Single Source of Truth**: All task states stored exclusively in `.task/impl-*.json` files
- **Dynamic Document Generation**: Markdown files generated on-demand as read-only views
- **Zero Synchronization**: Eliminates data consistency issues and sync complexity
- **Performance**: Direct JSON operations with <1ms query times
### **Marker File Session Management**
- **Ultra-Fast Operations**: Session switching through atomic file operations (`.workflow/.active-[session]`)
- **Self-Healing**: Automatic detection and resolution of session conflicts
- **Visual Management**: `ls .workflow/.active-*` shows current active session
- **Scalability**: Supports hundreds of concurrent sessions without performance degradation
### **Progressive Complexity**
CCW intelligently adapts its file structure and workflow processes based on task complexity:
- **Simple workflows**: Lightweight structure for single-file bug fixes
- **Medium workflows**: Enhanced documentation with progress visualization
- **Complex workflows**: Complete document suite with detailed implementation plans and multi-round iteration
CCW intelligently adapts its file structure and workflow processes based on unified task-count thresholds:
- **Simple workflows** (<5 tasks): Minimal structure, single-level hierarchy
- **Medium workflows** (5-15 tasks): Enhanced structure with progress tracking
- **Complex workflows** (>15 tasks): Complete document suite with 3-level task decomposition
## 🚀 Core Features
@@ -52,14 +61,28 @@ CCW intelligently adapts its file structure and workflow processes based on task
```
.claude/
├── agents/ # AI agent definitions and behaviors
├── commands/ # CLI command implementations
├── commands/ # CLI command implementations
├── output-styles/ # Output formatting templates
├── planning-templates/ # Role-specific planning approaches
├── prompt-templates/ # AI interaction templates
├── scripts/ # Automation scripts
├── tech-stack-templates/ # Technology-specific templates
├── workflows/ # Workflow definitions and guides
├── workflows/ # Core system architecture (v2.0)
│ ├── system-architecture.md # 🆕 Unified architecture overview
│ ├── data-model.md # 🆕 JSON-only task management spec
│ ├── complexity-rules.md # 🆕 Unified complexity standards
│ ├── session-management-principles.md # Marker file session system
│ ├── file-structure-standards.md # Progressive structure definitions
│ └── [gemini-*.md] # Gemini CLI integration templates
└── settings.local.json # Local configuration
.workflow/ # 🆕 Session workspace (auto-generated)
├── .active-[session-name] # 🆕 Active session marker file
└── WFS-[topic-slug]/ # Individual session directories
├── workflow-session.json # Session metadata
├── .task/impl-*.json # 🆕 JSON-only task definitions
├── IMPL_PLAN.md # Generated planning document
└── .summaries/ # Generated completion summaries
```
## 🚀 Quick Start
@@ -170,11 +193,18 @@ Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/cat
## 📊 Complexity-Based Strategies
| Complexity | Use Cases | Command Strategy | Documentation Level |
|------------|-----------|------------------|-------------------|
| **Simple** | Bug fixes, text changes, single-file updates | Skip brainstorming → Direct implementation → Minimal tasks | Light (session + log) |
| **Medium** | Multi-file features, refactoring, API changes | Optional brainstorming → Action plan → 2-level tasks → Progress tracking | Moderate (+ TODO_LIST.md) |
| **Complex** | Architecture changes, security modules, system-wide updates | Required brainstorming → Detailed planning → 3-level tasks → Risk assessment | Complete (full document suite) |
| Complexity | Task Count | Hierarchy Depth | File Structure | Command Strategy |
|------------|------------|----------------|----------------|------------------|
| **Simple** | <5 tasks | 1 level (impl-N) | Minimal structure | Skip brainstorming → Direct implementation |
| **Medium** | 5-15 tasks | 2 levels (impl-N.M) | Enhanced + auto-generated TODO_LIST.md | Optional brainstorming → Action plan → Progress tracking |
| **Complex** | >15 tasks | 3 levels (impl-N.M.P) | Complete document suite | Required brainstorming → Multi-agent orchestration → Deep context analysis |
### 🚀 Architecture v2.0 Benefits
- **Performance**: 95% faster session operations with marker file system
- **Consistency**: 100% data consistency with JSON-only model
- **Efficiency**: 40-50% reduction in maintenance overhead
- **Scalability**: Support for hundreds of concurrent sessions
- **Onboarding**: 50% faster learning curve with progressive complexity
## 🔧 Technical Highlights

View File

@@ -8,20 +8,29 @@
一个精密的多智能体自动化工作流框架将复杂的软件开发任务从概念构思到实现审查转化为可管理、可追踪、AI协调的流程。
> **🎉 重大架构升级 (v2.0)**:最近进行了全面重构,采用 **JSON纯数据模型**、**标记文件会话管理** 和 **统一复杂度标准**。详见 [WORKFLOW_SYSTEM_UPGRADE.md](WORKFLOW_SYSTEM_UPGRADE.md)。
## 🏗️ 架构概览
Claude Code Workflow (CCW) 建立在大基础支柱之上:
Claude Code Workflow (CCW) 建立在大基础支柱之上:
### **文档-状态分离**
- **文档 (*.md)**:存储人类可读的计划、策略、分析报告和总结
- **状态 (*.json)**:管理机器可读的、动态的工作流状态和任务定义
- 这种分离确保了健壮性、可恢复性和自动化处理能力
### **JSON纯数据模型**
- **单一数据源**:所有任务状态专门存储在 `.task/impl-*.json` 文件中
- **动态文档生成**Markdown文件按需生成为只读视图
- **零同步开销**:消除数据一致性问题和同步复杂性
- **高性能**直接JSON操作查询时间<1毫秒
### **标记文件会话管理**
- **超高速操作**:通过原子文件操作进行会话切换(`.workflow/.active-[session]`
- **自修复能力**:自动检测和解决会话冲突
- **可视化管理**`ls .workflow/.active-*` 显示当前活跃会话
- **可扩展性**:支持数百个并发会话而无性能下降
### **渐进式复杂度**
CCW 根据任务复杂度智能调整其文件结构和工作流程:
- **简单工作流**:用于单文件 Bug 修复的轻量级结构
- **中等工作流**:增强的文档和进度可视化
- **复杂工作流**:完整文档套件,包含详细的实现计划和多轮迭代
CCW 根据统一的任务数量阈值智能调整其文件结构和工作流程:
- **简单工作流** (<5个任务):最小结构,单级层次结构
- **中等工作流** (5-15个任务):增强结构,带进度跟踪
- **复杂工作流** (>15个任务):完整文档套件,3级任务分解
## 🚀 核心功能
@@ -58,8 +67,22 @@ CCW 根据任务复杂度智能调整其文件结构和工作流程:
├── prompt-templates/ # AI 交互模板
├── scripts/ # 自动化脚本
├── tech-stack-templates/ # 技术栈特定模板
├── workflows/ # 工作流定义和指南
├── workflows/ # 核心系统架构 (v2.0)
│ ├── system-architecture.md # 🆕 统一架构概览
│ ├── data-model.md # 🆕 JSON纯任务管理规范
│ ├── complexity-rules.md # 🆕 统一复杂度标准
│ ├── session-management-principles.md # 标记文件会话系统
│ ├── file-structure-standards.md # 渐进式结构定义
│ └── [gemini-*.md] # Gemini CLI 集成模板
└── settings.local.json # 本地配置
.workflow/ # 🆕 会话工作空间 (自动生成)
├── .active-[session-name] # 🆕 活跃会话标记文件
└── WFS-[topic-slug]/ # 个别会话目录
├── workflow-session.json # 会话元数据
├── .task/impl-*.json # 🆕 JSON纯任务定义
├── IMPL_PLAN.md # 生成的规划文档
└── .summaries/ # 生成的完成摘要
```
## 🚀 快速开始
@@ -170,11 +193,18 @@ Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/cat
## 📊 基于复杂度的策略
| 复杂度 | 使用场景 | 命令策略 | 文档级别 |
|------------|-----------|------------------|-------------------|
| **简单** | Bug修复、文本更改、单文件更新 | 跳过头脑风暴 → 直接实施 → 最小任务 | 轻量(会话+日志) |
| **中等** | 多文件功能、重构、API更改 | 可选头脑风暴 → 行动计划 → 2级任务 → 进度跟踪 | 中等(+ TODO_LIST.md |
| **复杂** | 架构更改、安全模块、系统级更新 | 必需头脑风暴 → 详细规划 → 3级任务 → 风险评估 | 完整(全套文档) |
| 复杂度 | 任务数量 | 层次深度 | 文件结构 | 命令策略 |
|------------|------------|----------------|----------------|------------------|
| **简单** | <5个任务 | 1级 (impl-N) | 最小结构 | 跳过头脑风暴 → 直接实施 |
| **中等** | 5-15个任务 | 2级 (impl-N.M) | 增强 + 自动生成TODO_LIST.md | 可选头脑风暴 → 行动计划 → 进度跟踪 |
| **复杂** | >15个任务 | 3级 (impl-N.M.P) | 完整文档套件 | 必需头脑风暴 → 多智能体编排 → 深度上下文分析 |
### 🚀 架构 v2.0 优势
- **性能提升**标记文件系统带来95%更快的会话操作
- **一致性保证**JSON纯模型提供100%数据一致性
- **效率提升**维护开销减少40-50%
- **可扩展性**:支持数百个并发会话
- **学习曲线**渐进式复杂度使学习时间缩短50%
## 🔧 技术亮点