Skip to content

Commit 12034c8

Browse files
catlog22claude
andcommitted
release: version v3.4.2 - CLI documentation refactoring
Updated documentation for v3.4.2 release focusing on CLI command documentation refactoring and single source of truth pattern. ## Changes **CHANGELOG.md**: - Added comprehensive v3.4.2 release notes - Documented 681 lines reduction across 7 CLI command files - Detailed removed duplicate sections and preserved unique content - Explained single source of truth pattern with intelligent-tools-strategy.md **README.md & README_CN.md**: - Updated version badge from v3.4.0 to v3.4.2 - Updated "What's New" section with v3.4.2 highlights - Documented CLI documentation refactoring benefits ## Release Summary v3.4.2 focuses on documentation quality and maintenance optimization: - Eliminated redundant documentation content - Established implicit reference pattern to strategy guide - Preserved all unique command-specific capabilities - Reduced maintenance overhead for future updates 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 467963e commit 12034c8

File tree

3 files changed

+81
-18
lines changed

3 files changed

+81
-18
lines changed

CHANGELOG.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,69 @@ All notable changes to Claude Code Workflow (CCW) will be documented in this fil
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [3.4.2] - 2025-10-05
9+
10+
### 📚 CLI Documentation Refactoring
11+
12+
This release focuses on eliminating redundant documentation by establishing a single source of truth (SSOT) pattern for CLI command references.
13+
14+
#### Changed
15+
16+
**CLI Command Documentation Refactoring**:
17+
- Refactored 7 CLI command documentation files to eliminate redundancy
18+
- Removed **681 total lines** of duplicate content across all files
19+
- Established implicit reference pattern to `intelligent-tools-strategy.md` (loaded in memory)
20+
- Preserved all unique command-specific content and capabilities
21+
22+
**Specific File Reductions**:
23+
- `analyze.md`: 117→61 lines (48% reduction)
24+
- `chat.md`: 118→62 lines (47% reduction)
25+
- `execute.md`: 180→100 lines (44% reduction)
26+
- `codex-execute.md`: 481→473 lines (2% - preserved unique workflow content)
27+
- `mode/bug-index.md`: 144→75 lines (48% reduction)
28+
- `mode/code-analysis.md`: 188→76 lines (60% reduction)
29+
- `mode/plan.md`: 100→76 lines (24% reduction)
30+
31+
**Removed Duplicate Sections**:
32+
- Universal Command Template (now only in `intelligent-tools-strategy.md`)
33+
- File Pattern Reference (centralized in strategy guide)
34+
- Complex Pattern Discovery (centralized in strategy guide)
35+
- MODE Field Definition (centralized in strategy guide)
36+
- Enhancement Integration details (referenced implicitly)
37+
- Session Persistence details (referenced implicitly)
38+
39+
**Preserved Unique Content**:
40+
- Command-specific purpose and parameters
41+
- Unique execution flows and capabilities
42+
- Specialized features (YOLO permissions, task decomposition, resume patterns)
43+
- Command-specific examples and workflows
44+
- File pattern auto-detection logic for analyze command
45+
- Group-based execution workflow for codex-execute command
46+
47+
#### Added
48+
49+
**Documentation Enhancement** (prior to refactoring):
50+
- Enhanced file pattern examples and complex pattern discovery documentation
51+
- Added semantic discovery workflow integration examples
52+
53+
#### Technical Details
54+
55+
**Single Source of Truth Pattern**:
56+
All CLI commands now reference `intelligent-tools-strategy.md` for:
57+
- Universal command template structure
58+
- File pattern syntax and examples
59+
- Complex pattern discovery workflows
60+
- MODE field definitions and permissions
61+
- Tool-specific features and capabilities
62+
63+
**Reference Pattern**:
64+
```markdown
65+
## Notes
66+
- Command templates and file patterns: see intelligent-tools-strategy.md (loaded in memory)
67+
```
68+
69+
This approach reduces maintenance overhead while ensuring documentation consistency across all CLI commands.
70+
871
## [3.4.1] - 2025-10-04
972

1073
### 🎯 Multi-Tool Support for Documentation Updates

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<div align="center">
44

5-
[![Version](https://img.shields.io/badge/version-v3.4.0-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases)
5+
[![Version](https://img.shields.io/badge/version-v3.4.2-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases)
66
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
77
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)]()
88
[![MCP Tools](https://img.shields.io/badge/🔧_MCP_Tools-Experimental-orange.svg)](https://github.com/modelcontextprotocol)
@@ -15,15 +15,15 @@
1515

1616
**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.
1717

18-
> **🎉 Latest: v3.4.0** - TDD workflow optimization & test generation enhancements. See [CHANGELOG.md](CHANGELOG.md) for details.
18+
> **🎉 Latest: v3.4.2** - CLI documentation refactoring & single source of truth. See [CHANGELOG.md](CHANGELOG.md) for details.
1919
>
20-
> **What's New in v3.4.0**:
21-
> - 🧪 **TDD Workflow Streamlining**: Unified IMPL_PLAN.md structure, 33% reduction in redundant files
22-
> - 🔄 **Test Coverage Analysis**: TDD workflow upgraded to 6 phases with Phase 3 test context gathering
23-
> - 🔁 **Iterative Green Phase**: Built-in test-fix-cycle in IMPL tasks with Gemini auto-diagnosis
24-
> - 🛠️ **Manual-First Fixes**: Gemini + bug-fix template diagnosis by default, optional `--use-codex` automation
25-
> - **Test-Gen Workflow Enhancement**: Added 3 supporting tool commands for complete test generation flow
26-
> - ⏱️ **Dynamic Timeout Allocation**: CLI tools default to 20-120min for large-scale analysis
20+
> **What's New in v3.4.2**:
21+
> - 📚 **CLI Documentation Refactoring**: Eliminated 681 lines of duplicate content across 7 command files
22+
> - 🎯 **Single Source of Truth**: Established implicit reference pattern to `intelligent-tools-strategy.md`
23+
> - 🔍 **Documentation Consistency**: All CLI commands now reference centralized strategy guide
24+
> - 💡 **Maintenance Optimization**: Reduced maintenance overhead while preserving unique command features
25+
> - **Enhanced Clarity**: Streamlined documentation focuses on command-specific capabilities
26+
> - 📖 **Better Organization**: File patterns, templates, and MODE definitions centralized
2727
2828
---
2929

README_CN.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<div align="center">
44

5-
[![Version](https://img.shields.io/badge/version-v3.4.0-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases)
5+
[![Version](https://img.shields.io/badge/version-v3.4.2-blue.svg)](https://github.com/catlog22/Claude-Code-Workflow/releases)
66
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
77
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)]()
88
[![MCP工具](https://img.shields.io/badge/🔧_MCP工具-实验性-orange.svg)](https://github.com/modelcontextprotocol)
@@ -15,15 +15,15 @@
1515

1616
**Claude Code Workflow (CCW)** 是一个新一代的多智能体自动化开发框架,通过智能工作流管理和自主执行来协调复杂的软件开发任务。
1717

18-
> **🎉 最新版本: v3.4.0** - TDD 工作流优化与测试生成增强。详见 [CHANGELOG.md](CHANGELOG.md)
18+
> **🎉 最新版本: v3.4.2** - CLI 文档重构与单一信息源。详见 [CHANGELOG.md](CHANGELOG.md)
1919
>
20-
> **v3.4.0 版本新特性**:
21-
> - 🧪 **TDD 工作流优化**: 精简文件结构,统一使用 IMPL_PLAN.md,减少 33% 冗余文件
22-
> - 🔄 **测试覆盖分析**: TDD 工作流升级至 6 阶段,新增 Phase 3 测试上下文收集
23-
> - 🔁 **迭代 Green Phase**: IMPL 任务内置 test-fix-cycle,支持 Gemini 自动诊断和修复
24-
> - 🛠️ **手动优先修复**: 默认使用 Gemini + bug-fix 模板诊断,可选 `--use-codex` 自动化
25-
> - **test-gen 工作流增强**: 新增 3 个配套工具命令,完整测试生成和修复流程
26-
> - ⏱️ **动态超时分配**: CLI 工具默认 20-120 分钟超时,适应大型项目分析
20+
> **v3.4.2 版本新特性**:
21+
> - 📚 **CLI 文档重构**: 消除 7 个命令文件中的 681 行重复内容
22+
> - 🎯 **单一信息源**: 建立对 `intelligent-tools-strategy.md` 的隐式引用模式
23+
> - 🔍 **文档一致性**: 所有 CLI 命令现在引用集中的策略指南
24+
> - 💡 **维护优化**: 降低维护开销,同时保留独特的命令功能
25+
> - **增强清晰度**: 精简的文档专注于命令特定功能
26+
> - 📖 **更好的组织**: 文件模式、模板和 MODE 定义集中化
2727
2828
---
2929

0 commit comments

Comments
 (0)