mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
docs: 发布 v5.5.0 - 交互式命令指南与增强文档
版本更新: v5.4.0 → v5.5.0 核心改进: - ✨ 命令指南技能 - 支持 CCW-help 和 CCW-issue 关键词触发 - ✨ 增强命令描述 - 所有 69 个命令更新了详细功能说明 - ✨ 5 索引命令系统 - 按分类、使用场景、关系和核心命令组织 - ✨ 智能推荐 - 基于上下文的下一步操作建议 文档更新: - README.md / README_CN.md: 新增"需要帮助？"章节，介绍 CCW-help/CCW-issue 用法 - CHANGELOG.md: 添加完整的 v5.5.0 版本说明（109行详细内容） - SKILL.md: 更新版本至 v1.1.0 命令指南功能: - 🔍 智能命令搜索 - 按关键词、分类或场景查找 - 🤖 下一步推荐 - 工作流引导和上下文建议 - 📖 详细文档 - 参数、示例和最佳实践 - 🎓 新手入门 - 14 个核心命令学习路径 - 📝 问题报告 - 标准化 bug 报告和功能请求模板 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
catlog22
@@ -174,6 +174,6 @@ Team members get latest indexes via `git pull`.
|
||||
|
||||
---
|
||||
|
||||
**Version**: 1.0.0
|
||||
**Last Updated**: 2025-01-06
|
||||
**Version**: 1.1.0
|
||||
**Last Updated**: 2025-11-06
|
||||
**Maintainer**: Claude DMS3 Team
|
||||
|
||||
98
CHANGELOG.md
98
CHANGELOG.md
@@ -5,6 +5,104 @@ 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).
|
||||
|
||||
|
||||
## [5.5.0] - 2025-11-06
|
||||
|
||||
### 🎯 Interactive Command Guide & Enhanced Documentation
|
||||
|
||||
This release introduces a comprehensive command-guide skill with interactive help, enhanced command descriptions, and an organized 5-index command system for better discoverability and workflow guidance.
|
||||
|
||||
#### ✨ Added
|
||||
|
||||
**Command-Guide Skill**:
|
||||
- ✨ **Interactive Help System** - New command-guide skill activated by CCW-help and CCW-issue keywords
|
||||
- 🔍 Mode 1: Command Search - Find commands by keyword, category, or use-case
|
||||
- 🤖 Mode 2: Smart Recommendations - Context-aware next-step suggestions
|
||||
- 📖 Mode 3: Full Documentation - Detailed parameter info, examples, best practices
|
||||
- 🎓 Mode 4: Beginner Onboarding - Top 14 essential commands with learning path
|
||||
- 📝 Mode 5: Issue Reporting - Guided bug report and feature request templates
|
||||
|
||||
**5-Index Command System**:
|
||||
- ✨ **all-commands.json** (30KB) - Complete catalog of 69 commands with full metadata
|
||||
- ✨ **by-category.json** (33KB) - Hierarchical organization (workflow/cli/memory/task/general)
|
||||
- ✨ **by-use-case.json** (32KB) - Grouped by 10 usage scenarios
|
||||
- ✨ **essential-commands.json** (5.8KB) - Top 14 most-used commands for quick reference
|
||||
- ✨ **command-relationships.json** (13KB) - Workflow guidance with next-steps and dependencies
|
||||
|
||||
**Issue Templates**:
|
||||
- ✨ **Bug Report Template** - Standardized bug reporting with environment info
|
||||
- ✨ **Feature Request Template** - Structured feature proposals with use cases
|
||||
- ✨ **Question Template** - Help request format for user support
|
||||
|
||||
#### 🔄 Changed
|
||||
|
||||
**Command Descriptions Enhanced** (69 files):
|
||||
- 🔄 **Detailed Functionality** - All command descriptions updated from basic to comprehensive
|
||||
- Includes tools used (Gemini/Qwen/Codex)
|
||||
- Specifies agents invoked
|
||||
- Lists workflow phases
|
||||
- Documents output files
|
||||
- Mentions key flags and modes
|
||||
- 🔄 **Example Updates**:
|
||||
- `workflow:plan`: "5-phase planning workflow with Gemini analysis and action-planning-agent task generation, outputs IMPL_PLAN.md and task JSONs with optional CLI auto-execution"
|
||||
- `cli:execute`: "Autonomous code implementation with YOLO auto-approval using Gemini/Qwen/Codex, supports task ID or description input with automatic file pattern detection"
|
||||
- `memory:update-related`: "Update CLAUDE.md for git-changed modules using batched agent execution (4 modules/agent) with gemini→qwen→codex fallback"
|
||||
|
||||
**Index Organization**:
|
||||
- 🔄 **Use-Case Categories Expanded** - From 2 to 10 distinct scenarios
|
||||
- session-management, implementation, documentation, planning, ui-design, testing, brainstorming, analysis, monitoring, utilities
|
||||
- 🔄 **Command Relationships Comprehensive** - All 69 commands mapped with:
|
||||
- `calls_internally` - Commands auto-invoked (built-in)
|
||||
- `next_steps` - User-executed next commands (sequential)
|
||||
- `prerequisites` - Commands to run before
|
||||
- `alternatives` - Similar-purpose commands
|
||||
|
||||
**Maintenance Tools**:
|
||||
- 🔄 **analyze_commands.py** - Moved to scripts/ directory
|
||||
- Auto-generates all 5 index files from command frontmatter
|
||||
- Validates JSON syntax
|
||||
- Provides statistical reports
|
||||
|
||||
#### 📝 Documentation
|
||||
|
||||
**New Files**:
|
||||
- ✨ **guides/index-structure.md** - Complete index file schema documentation
|
||||
- ✨ **guides/implementation-details.md** - 5-mode implementation logic
|
||||
- ✨ **guides/examples.md** - Usage examples for all modes
|
||||
- ✨ **guides/getting-started.md** - 5-minute quickstart guide
|
||||
- ✨ **guides/workflow-patterns.md** - Common workflow examples
|
||||
- ✨ **guides/cli-tools-guide.md** - Gemini/Qwen/Codex usage
|
||||
- ✨ **guides/troubleshooting.md** - Common issues and solutions
|
||||
|
||||
**Updated Files**:
|
||||
- 🔄 **README.md** - Added "Need Help?" section with CCW-help/CCW-issue usage
|
||||
- 🔄 **README_CN.md** - Chinese version of help documentation
|
||||
- 🔄 **SKILL.md** - Optimized to 179 lines (from 412, 56.6% reduction)
|
||||
- Clear 5-mode operation structure
|
||||
- Explicit CCW-help and CCW-issue triggers
|
||||
- Progressive disclosure pattern
|
||||
|
||||
#### 🎯 Benefits
|
||||
|
||||
**User Experience**:
|
||||
- 📦 **Easier Discovery** - CCW-help provides instant command search and recommendations
|
||||
- 📦 **Better Guidance** - Smart next-step suggestions based on workflow context
|
||||
- 📦 **Faster Onboarding** - Essential commands list gets beginners started quickly
|
||||
- 📦 **Simplified Reporting** - CCW-issue generates proper bug/feature templates
|
||||
|
||||
**Developer Experience**:
|
||||
- ⚡ **Comprehensive Metadata** - All 69 commands fully documented with tools, agents, phases
|
||||
- ⚡ **Workflow Clarity** - Command relationships show built-in vs sequential execution
|
||||
- ⚡ **Automated Maintenance** - analyze_commands.py regenerates indexes from source
|
||||
- ⚡ **Quality Documentation** - 7 guide files cover all aspects of the system
|
||||
|
||||
**System Organization**:
|
||||
- 🏗️ **Structured Indexes** - 5 JSON files provide multiple access patterns
|
||||
- 🏗️ **Clear Relationships** - Distinguish built-in calls from user workflows
|
||||
- 🏗️ **Scalable Architecture** - Easy to add new commands with auto-indexing
|
||||
|
||||
---
|
||||
|
||||
## [5.4.0] - 2025-11-06
|
||||
|
||||
### 🎯 CLI Template System Reorganization
|
||||
|
||||
42
README.md
42
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](LICENSE)
|
||||
[]()
|
||||
|
||||
@@ -14,13 +14,13 @@
|
||||
|
||||
**Claude Code Workflow (CCW)** transforms AI development from simple prompt chaining into a robust, context-first orchestration system. It solves execution uncertainty and error accumulation through structured planning, deterministic execution, and intelligent multi-model orchestration.
|
||||
|
||||
> **🎉 Version 5.4: CLI Template System Reorganization**
|
||||
> **🎉 Version 5.5: Interactive Command Guide & Enhanced Documentation**
|
||||
>
|
||||
> **Core Improvements**:
|
||||
> - ✅ **Priority-Based Templates** - 19 templates reorganized with clear priority prefixes (01-universal, 02-specialized, 03-domain)
|
||||
> - ✅ **Enhanced Error Handling** - Automatic Gemini 404 fallback to gemini-2.5-pro
|
||||
> - ✅ **Unified References** - All 21 template references updated across 5 command files
|
||||
> - ✅ **Better Organization** - Bug diagnosis moved to analysis/, redundant directories removed
|
||||
> - ✨ **Command-Guide Skill** - Interactive help system with CCW-help and CCW-issue triggers
|
||||
> - ✨ **Enhanced Command Descriptions** - All 69 commands updated with detailed functionality descriptions
|
||||
> - ✨ **5-Index Command System** - Organized by category, use-case, relationships, and essentials
|
||||
> - ✨ **Smart Recommendations** - Context-aware next-step suggestions for workflow guidance
|
||||
>
|
||||
> See [CHANGELOG.md](CHANGELOG.md) for full details.
|
||||
|
||||
@@ -74,6 +74,34 @@ For a detailed technical specification of every command, see the [**COMMAND_SPEC
|
||||
|
||||
---
|
||||
|
||||
### 💡 **Need Help? Use the Interactive Command Guide**
|
||||
|
||||
CCW includes a built-in **command-guide skill** to help you discover and use commands effectively:
|
||||
|
||||
- **`CCW-help`** - Get interactive help and command recommendations
|
||||
- **`CCW-issue`** - Report bugs or request features with guided templates
|
||||
|
||||
The command guide provides:
|
||||
- 🔍 **Smart Command Search** - Find commands by keyword, category, or use-case
|
||||
- 🤖 **Next-Step Recommendations** - Get suggestions for what to do after any command
|
||||
- 📖 **Detailed Documentation** - View parameters, examples, and best practices
|
||||
- 🎓 **Beginner Onboarding** - Learn the top 14 essential commands with a guided learning path
|
||||
- 📝 **Issue Reporting** - Generate standardized bug reports and feature requests
|
||||
|
||||
**Example Usage**:
|
||||
```
|
||||
User: "CCW-help"
|
||||
→ Interactive menu with command search, recommendations, and documentation
|
||||
|
||||
User: "What's next after /workflow:plan?"
|
||||
→ Recommends /workflow:execute, /workflow:action-plan-verify, with workflow patterns
|
||||
|
||||
User: "CCW-issue"
|
||||
→ Guided template generation for bugs, features, or questions
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
The best way to get started is to follow the 5-minute tutorial in the [**Getting Started Guide**](GETTING_STARTED.md).
|
||||
@@ -103,4 +131,4 @@ Here is a quick example of a common development workflow:
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
|
||||
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
|
||||
|
||||
40
README_CN.md
40
README_CN.md
@@ -2,7 +2,7 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](https://github.com/catlog22/Claude-Code-Workflow/releases)
|
||||
[](LICENSE)
|
||||
[]()
|
||||
|
||||
@@ -14,13 +14,13 @@
|
||||
|
||||
**Claude Code Workflow (CCW)** 将 AI 开发从简单的提示词链接转变为一个强大的、上下文优先的编排系统。它通过结构化规划、确定性执行和智能多模型编排，解决了执行不确定性和误差累积的问题。
|
||||
|
||||
> **🎉 版本 5.4: CLI 模板系统重组**
|
||||
> **🎉 版本 5.5: 交互式命令指南与增强文档**
|
||||
>
|
||||
> **核心改进**:
|
||||
> - ✅ **优先级模板** - 19个模板重组，采用清晰的优先级前缀（01-通用，02-专用，03-领域）
|
||||
> - ✅ **增强错误处理** - Gemini 404 错误自动回退到 gemini-2.5-pro
|
||||
> - ✅ **统一引用** - 5个命令文件中的21处模板引用全部更新
|
||||
> - ✅ **优化组织** - Bug诊断移至analysis/，移除冗余目录
|
||||
> - ✨ **命令指南技能** - 交互式帮助系统，支持 CCW-help 和 CCW-issue 触发
|
||||
> - ✨ **增强命令描述** - 所有 69 个命令更新了详细功能描述
|
||||
> - ✨ **5 索引命令系统** - 按分类、使用场景、关系和核心命令组织
|
||||
> - ✨ **智能推荐** - 基于上下文的工作流引导建议
|
||||
>
|
||||
> 详见 [CHANGELOG.md](CHANGELOG.md)。
|
||||
|
||||
@@ -74,6 +74,34 @@ CCW 提供了一套丰富的命令，用于管理工作流、任务以及与 AI
|
||||
|
||||
---
|
||||
|
||||
### 💡 **需要帮助？使用交互式命令指南**
|
||||
|
||||
CCW 包含内置的**命令指南技能**，帮助您有效地发现和使用命令：
|
||||
|
||||
- **`CCW-help`** - 获取交互式帮助和命令推荐
|
||||
- **`CCW-issue`** - 使用引导模板报告错误或请求功能
|
||||
|
||||
命令指南提供：
|
||||
- 🔍 **智能命令搜索** - 按关键词、分类或使用场景查找命令
|
||||
- 🤖 **下一步推荐** - 获取任何命令之后的操作建议
|
||||
- 📖 **详细文档** - 查看参数、示例和最佳实践
|
||||
- 🎓 **新手入门** - 通过引导式学习路径学习 14 个核心命令
|
||||
- 📝 **问题报告** - 生成标准化的错误报告和功能请求
|
||||
|
||||
**使用示例**:
|
||||
```
|
||||
用户: "CCW-help"
|
||||
→ 交互式菜单，包含命令搜索、推荐和文档
|
||||
|
||||
用户: "执行完 /workflow:plan 后做什么？"
|
||||
→ 推荐 /workflow:execute、/workflow:action-plan-verify 及工作流模式
|
||||
|
||||
用户: "CCW-issue"
|
||||
→ 引导式模板生成，用于错误、功能或问题咨询
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速入门
|
||||
|
||||
开始使用的最佳方式是遵循 [**快速上手指南**](GETTING_STARTED_CN.md) 中的 5 分钟教程。
|
||||
|
||||
Reference in New Issue
Block a user