diff --git a/CHANGELOG.md b/CHANGELOG.md index 0843cf5e..8af85acf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,69 @@ All notable changes to Claude Code Workflow (CCW) will be documented in this fil The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [3.4.2] - 2025-10-05 + +### 📚 CLI Documentation Refactoring + +This release focuses on eliminating redundant documentation by establishing a single source of truth (SSOT) pattern for CLI command references. + +#### Changed + +**CLI Command Documentation Refactoring**: +- Refactored 7 CLI command documentation files to eliminate redundancy +- Removed **681 total lines** of duplicate content across all files +- Established implicit reference pattern to `intelligent-tools-strategy.md` (loaded in memory) +- Preserved all unique command-specific content and capabilities + +**Specific File Reductions**: +- `analyze.md`: 117→61 lines (48% reduction) +- `chat.md`: 118→62 lines (47% reduction) +- `execute.md`: 180→100 lines (44% reduction) +- `codex-execute.md`: 481→473 lines (2% - preserved unique workflow content) +- `mode/bug-index.md`: 144→75 lines (48% reduction) +- `mode/code-analysis.md`: 188→76 lines (60% reduction) +- `mode/plan.md`: 100→76 lines (24% reduction) + +**Removed Duplicate Sections**: +- Universal Command Template (now only in `intelligent-tools-strategy.md`) +- File Pattern Reference (centralized in strategy guide) +- Complex Pattern Discovery (centralized in strategy guide) +- MODE Field Definition (centralized in strategy guide) +- Enhancement Integration details (referenced implicitly) +- Session Persistence details (referenced implicitly) + +**Preserved Unique Content**: +- Command-specific purpose and parameters +- Unique execution flows and capabilities +- Specialized features (YOLO permissions, task decomposition, resume patterns) +- Command-specific examples and workflows +- File pattern auto-detection logic for analyze command +- Group-based execution workflow for codex-execute command + +#### Added + +**Documentation Enhancement** (prior to refactoring): +- Enhanced file pattern examples and complex pattern discovery documentation +- Added semantic discovery workflow integration examples + +#### Technical Details + +**Single Source of Truth Pattern**: +All CLI commands now reference `intelligent-tools-strategy.md` for: +- Universal command template structure +- File pattern syntax and examples +- Complex pattern discovery workflows +- MODE field definitions and permissions +- Tool-specific features and capabilities + +**Reference Pattern**: +```markdown +## Notes +- Command templates and file patterns: see intelligent-tools-strategy.md (loaded in memory) +``` + +This approach reduces maintenance overhead while ensuring documentation consistency across all CLI commands. + ## [3.4.1] - 2025-10-04 ### 🎯 Multi-Tool Support for Documentation Updates diff --git a/README.md b/README.md index 7102fb48..77e1ace7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@
-[![Version](https://img.shields.io/badge/version-v3.4.0-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases) +[![Version](https://img.shields.io/badge/version-v3.4.2-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) [![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)]() [![MCP Tools](https://img.shields.io/badge/🔧_MCP_Tools-Experimental-orange.svg)](https://github.com/modelcontextprotocol) @@ -15,15 +15,15 @@ **Claude Code Workflow (CCW)** is a next-generation multi-agent automation framework that orchestrates complex software development tasks through intelligent workflow management and autonomous execution. -> **🎉 Latest: v3.4.0** - TDD workflow optimization & test generation enhancements. See [CHANGELOG.md](CHANGELOG.md) for details. +> **🎉 Latest: v3.4.2** - CLI documentation refactoring & single source of truth. See [CHANGELOG.md](CHANGELOG.md) for details. > -> **What's New in v3.4.0**: -> - 🧪 **TDD Workflow Streamlining**: Unified IMPL_PLAN.md structure, 33% reduction in redundant files -> - 🔄 **Test Coverage Analysis**: TDD workflow upgraded to 6 phases with Phase 3 test context gathering -> - 🔁 **Iterative Green Phase**: Built-in test-fix-cycle in IMPL tasks with Gemini auto-diagnosis -> - 🛠️ **Manual-First Fixes**: Gemini + bug-fix template diagnosis by default, optional `--use-codex` automation -> - ✅ **Test-Gen Workflow Enhancement**: Added 3 supporting tool commands for complete test generation flow -> - ⏱️ **Dynamic Timeout Allocation**: CLI tools default to 20-120min for large-scale analysis +> **What's New in v3.4.2**: +> - 📚 **CLI Documentation Refactoring**: Eliminated 681 lines of duplicate content across 7 command files +> - 🎯 **Single Source of Truth**: Established implicit reference pattern to `intelligent-tools-strategy.md` +> - 🔍 **Documentation Consistency**: All CLI commands now reference centralized strategy guide +> - 💡 **Maintenance Optimization**: Reduced maintenance overhead while preserving unique command features +> - ✨ **Enhanced Clarity**: Streamlined documentation focuses on command-specific capabilities +> - 📖 **Better Organization**: File patterns, templates, and MODE definitions centralized --- diff --git a/README_CN.md b/README_CN.md index 3cdbc21f..bffc131c 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,7 +2,7 @@
-[![Version](https://img.shields.io/badge/version-v3.4.0-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases) +[![Version](https://img.shields.io/badge/version-v3.4.2-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) [![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)]() [![MCP工具](https://img.shields.io/badge/🔧_MCP工具-实验性-orange.svg)](https://github.com/modelcontextprotocol) @@ -15,15 +15,15 @@ **Claude Code Workflow (CCW)** 是一个新一代的多智能体自动化开发框架,通过智能工作流管理和自主执行来协调复杂的软件开发任务。 -> **🎉 最新版本: v3.4.0** - TDD 工作流优化与测试生成增强。详见 [CHANGELOG.md](CHANGELOG.md)。 +> **🎉 最新版本: v3.4.2** - CLI 文档重构与单一信息源。详见 [CHANGELOG.md](CHANGELOG.md)。 > -> **v3.4.0 版本新特性**: -> - 🧪 **TDD 工作流优化**: 精简文件结构,统一使用 IMPL_PLAN.md,减少 33% 冗余文件 -> - 🔄 **测试覆盖分析**: TDD 工作流升级至 6 阶段,新增 Phase 3 测试上下文收集 -> - 🔁 **迭代 Green Phase**: IMPL 任务内置 test-fix-cycle,支持 Gemini 自动诊断和修复 -> - 🛠️ **手动优先修复**: 默认使用 Gemini + bug-fix 模板诊断,可选 `--use-codex` 自动化 -> - ✅ **test-gen 工作流增强**: 新增 3 个配套工具命令,完整测试生成和修复流程 -> - ⏱️ **动态超时分配**: CLI 工具默认 20-120 分钟超时,适应大型项目分析 +> **v3.4.2 版本新特性**: +> - 📚 **CLI 文档重构**: 消除 7 个命令文件中的 681 行重复内容 +> - 🎯 **单一信息源**: 建立对 `intelligent-tools-strategy.md` 的隐式引用模式 +> - 🔍 **文档一致性**: 所有 CLI 命令现在引用集中的策略指南 +> - 💡 **维护优化**: 降低维护开销,同时保留独特的命令功能 +> - ✨ **增强清晰度**: 精简的文档专注于命令特定功能 +> - 📖 **更好的组织**: 文件模式、模板和 MODE 定义集中化 ---