mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-01 15:03:57 +08:00
Refactor documentation for code commands and workflows
- Updated command syntax formatting to use code blocks for clarity in `prep.md`, `review.md`, and `spec.md`. - Enhanced architectural diagrams in `ch01-what-is-claude-dms3.md` and core concepts in `ch03-core-concepts.md` using mermaid syntax for better visualization. - Improved workflow diagrams in `ch04-workflow-basics.md` and `4-level.md` to provide clearer representations of processes. - Added troubleshooting section in `installation.md` to address common installation issues and provide quick start examples. - Revised skill documentation in `claude-meta.md` and `claude-workflow.md` to standardize command triggers and output structures. - Updated best practices and workflow index documentation to enhance readability and understanding of workflow levels and practices.
This commit is contained in:
catlog22
@@ -32,7 +32,7 @@
|
||||
**One-Liner**: Specification generator — 6-stage document chain generates complete specification package (product brief, PRD, architecture, Epics)
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/spec-generator <idea>
|
||||
/spec-generator --continue # Resume from checkpoint
|
||||
/spec-generator -y <idea> # Auto mode
|
||||
@@ -46,7 +46,7 @@
|
||||
- Documentation only: No code generation or execution — clean handoff to existing execution workflows
|
||||
|
||||
**Architecture Overview**:
|
||||
```
|
||||
```plaintext
|
||||
Phase 0: Specification Study (Read specs/ + templates/ - mandatory prerequisite)
|
||||
|
|
||||
Phase 1: Discovery -> spec-config.json + discovery-context.json
|
||||
@@ -85,7 +85,7 @@ Phase 6: Readiness Check -> readiness-report.md + spec-summary.md
|
||||
| [templates/epics-template.md](templates/epics-template.md) | Epic/Story document template |
|
||||
|
||||
**Output Structure**:
|
||||
```
|
||||
```plaintext
|
||||
.workflow/.spec/SPEC-{slug}-{YYYY-MM-DD}/
|
||||
├── spec-config.json # Session config + stage status
|
||||
├── discovery-context.json # Codebase exploration results (optional)
|
||||
@@ -119,7 +119,7 @@ Phase 6: Readiness Check -> readiness-report.md + spec-summary.md
|
||||
**One-Liner**: Brainstorming — Interactive framework generation, multi-role parallel analysis, and cross-role synthesis
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/brainstorm <topic>
|
||||
/brainstorm --count 3 "Build platform"
|
||||
/brainstorm -y "GOAL: Build SCOPE: Users" --count 5
|
||||
@@ -169,7 +169,7 @@ Artifacts N×Role Synthesis 1×Role
|
||||
| `ux-expert` | UX Expert | User research, information architecture, journeys |
|
||||
|
||||
**Output Structure**:
|
||||
```
|
||||
```plaintext
|
||||
.workflow/active/WFS-{topic}/
|
||||
├── workflow-session.json # Session metadata
|
||||
├── .process/
|
||||
@@ -204,7 +204,7 @@ Artifacts N×Role Synthesis 1×Role
|
||||
**One-Liner**: Skill generator — Meta-skill for creating new Claude Code Skills
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/skill-generator
|
||||
/create skill
|
||||
/new skill
|
||||
@@ -242,7 +242,7 @@ Artifacts N×Role Synthesis 1×Role
|
||||
| [templates/autonomous-action.md](templates/autonomous-action.md) | Autonomous action template |
|
||||
|
||||
**Execution Flow**:
|
||||
```
|
||||
```plaintext
|
||||
Phase 0: Specification Study (Mandatory)
|
||||
- Read: ../_shared/SKILL-DESIGN-SPEC.md
|
||||
- Read: All templates/*.md files
|
||||
@@ -269,7 +269,7 @@ Phase 5: Verification and Documentation
|
||||
```
|
||||
|
||||
**Output Structure** (Sequential):
|
||||
```
|
||||
```plaintext
|
||||
.claude/skills/{skill-name}/
|
||||
├── SKILL.md # Entry file
|
||||
├── phases/
|
||||
@@ -294,7 +294,7 @@ Phase 5: Verification and Documentation
|
||||
**One-Liner**: CCW command help system — Command search, recommendations, documentation viewing
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/ccw-help
|
||||
/ccw "task description" # Auto-select workflow and execute
|
||||
/ccw-help search <keyword> # Search commands
|
||||
@@ -356,7 +356,7 @@ Phase 5: Verification and Documentation
|
||||
**One-Liner**: Skill tuning diagnosis — Automated diagnosis and optimization recommendations
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/skill-tuning <skill-name>
|
||||
```
|
||||
|
||||
@@ -367,7 +367,7 @@ Phase 5: Verification and Documentation
|
||||
- Verify improvements
|
||||
|
||||
**Diagnosis Flow**:
|
||||
```
|
||||
```plaintext
|
||||
Analyze Skill → Identify issues → Generate recommendations → Apply optimizations → Verify effects
|
||||
```
|
||||
|
||||
@@ -378,7 +378,7 @@ Analyze Skill → Identify issues → Generate recommendations → Apply optimiz
|
||||
**One-Liner**: Command generator — Generate Claude commands
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/command-generator
|
||||
```
|
||||
|
||||
@@ -394,7 +394,7 @@ Analyze Skill → Identify issues → Generate recommendations → Apply optimiz
|
||||
**One-Liner**: Issue management — Issue creation, updates, status management
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/issue-manage
|
||||
/issue:new
|
||||
```
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
**One-Liner**: Unified planning skill — 4-stage workflow, plan verification, interactive re-planning
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:plan <task-description>
|
||||
/workflow:plan-verify --session <session-id>
|
||||
/workflow:replan --session <session-id> [task-id] "requirements"
|
||||
@@ -61,7 +61,7 @@ default → 'plan'
|
||||
6. **Accumulated state**: planning-notes.md carries context across phases for N+1 decisions
|
||||
|
||||
**Plan Mode Data Flow**:
|
||||
```
|
||||
```plaintext
|
||||
User Input (task description)
|
||||
↓
|
||||
[Convert to structured format]
|
||||
@@ -106,7 +106,7 @@ Plan Confirmation (User Decision Gate):
|
||||
**One-Liner**: Agent-coordinated execution — Systematic task discovery, agent coordination, and state tracking
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:execute
|
||||
/workflow:execute --resume-session="WFS-auth"
|
||||
/workflow:execute --yes
|
||||
@@ -125,7 +125,7 @@ Plan Confirmation (User Decision Gate):
|
||||
- **Completion selection**: Auto-complete session (run `/workflow:session:complete --yes`)
|
||||
|
||||
**Execution Process**:
|
||||
```
|
||||
```plaintext
|
||||
Phase 1: Discovery
|
||||
├─ Count active sessions
|
||||
└─ Decision:
|
||||
@@ -188,7 +188,7 @@ Phase 5: Completion
|
||||
**One-Liner**: Lightweight quick planning — Quick planning and execution for super simple tasks
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:lite-plan <simple-task>
|
||||
```
|
||||
|
||||
@@ -210,7 +210,7 @@ Phase 5: Completion
|
||||
**One-Liner**: Multi-CLI collaborative planning — Analysis and planning with multiple CLI tools collaborating
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:multi-cli-plan <task>
|
||||
```
|
||||
|
||||
@@ -231,7 +231,7 @@ Phase 5: Completion
|
||||
**One-Liner**: TDD workflow — Test-driven development process
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:tdd <feature-description>
|
||||
```
|
||||
|
||||
@@ -242,7 +242,7 @@ Phase 5: Completion
|
||||
- Loop until passing
|
||||
|
||||
**Pipeline**:
|
||||
```
|
||||
```plaintext
|
||||
Plan Tests → Write Tests → [Fail] → Implement Feature → [Pass] → Complete
|
||||
↑___________|
|
||||
```
|
||||
@@ -254,7 +254,7 @@ Plan Tests → Write Tests → [Fail] → Implement Feature → [Pass] → Compl
|
||||
**One-Liner**: Test-fix workflow — Diagnosis and fixing of failing tests
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:test-fix <failing-tests>
|
||||
```
|
||||
|
||||
@@ -265,7 +265,7 @@ Plan Tests → Write Tests → [Fail] → Implement Feature → [Pass] → Compl
|
||||
- Loop until passing
|
||||
|
||||
**Pipeline**:
|
||||
```
|
||||
```plaintext
|
||||
Diagnose Failure → Identify Root Cause → [Code Issue] → Fix Code → Verify
|
||||
↑___________|
|
||||
```
|
||||
@@ -277,7 +277,7 @@ Diagnose Failure → Identify Root Cause → [Code Issue] → Fix Code → Verif
|
||||
**One-Liner**: Skill design workflow — Create new Claude Code Skills
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:skill-designer <skill-idea>
|
||||
```
|
||||
|
||||
@@ -289,7 +289,7 @@ Diagnose Failure → Identify Root Cause → [Code Issue] → Fix Code → Verif
|
||||
- Verification and documentation
|
||||
|
||||
**Output Structure**:
|
||||
```
|
||||
```plaintext
|
||||
.claude/skills/{skill-name}/
|
||||
├── SKILL.md # Entry file
|
||||
├── phases/
|
||||
@@ -307,7 +307,7 @@ Diagnose Failure → Identify Root Cause → [Code Issue] → Fix Code → Verif
|
||||
**One-Liner**: Wave batch planning — Parallel processing planning for batch issues
|
||||
|
||||
**Trigger**:
|
||||
```
|
||||
```shell
|
||||
/workflow:wave-plan <issue-list>
|
||||
```
|
||||
|
||||
@@ -318,7 +318,7 @@ Diagnose Failure → Identify Root Cause → [Code Issue] → Fix Code → Verif
|
||||
- Execution queue generation
|
||||
|
||||
**Wave Model**:
|
||||
```
|
||||
```plaintext
|
||||
Wave 1: Issue 1-5 → Parallel planning → Parallel execution
|
||||
Wave 2: Issue 6-10 → Parallel planning → Parallel execution
|
||||
...
|
||||
|
||||
@@ -40,7 +40,7 @@
|
||||
**One-Liner**: Full lifecycle orchestrator — spawn-wait-close pipeline for spec/implementation/test
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/team-lifecycle <task-description>
|
||||
```
|
||||
|
||||
@@ -65,7 +65,7 @@
|
||||
| fe-qa | Frontend QA, GC loop | 2.3 Deep Interaction |
|
||||
|
||||
**Pipeline Definition**:
|
||||
```
|
||||
```plaintext
|
||||
Spec-only (6 beats):
|
||||
RESEARCH-001(+D1) → DRAFT-001(+D2) → DRAFT-002(+D3) → DRAFT-003(+D4) → DRAFT-004(+D5) → QUALITY-001(+D6)
|
||||
|
||||
@@ -77,7 +77,7 @@ Full-lifecycle (9 beats):
|
||||
```
|
||||
|
||||
**Beat Cycle**:
|
||||
```
|
||||
```plaintext
|
||||
event (phase advance / user resume)
|
||||
↓
|
||||
[Orchestrator]
|
||||
@@ -93,7 +93,7 @@ event (phase advance / user resume)
|
||||
```
|
||||
|
||||
**Session Directory**:
|
||||
```
|
||||
```plaintext
|
||||
.workflow/.team/TLS-<slug>-<date>/
|
||||
├── team-session.json # Pipeline state
|
||||
├── spec/ # Specification artifacts
|
||||
@@ -112,7 +112,7 @@ event (phase advance / user resume)
|
||||
**One-Liner**: Multi-agent parallel development cycle — requirements analysis, exploration planning, code development, validation
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/parallel-dev-cycle TASK="Implement feature"
|
||||
/parallel-dev-cycle --cycle-id=cycle-v1-20260122-abc123
|
||||
/parallel-dev-cycle --auto TASK="Add OAuth"
|
||||
@@ -138,7 +138,7 @@ event (phase advance / user resume)
|
||||
- Eliminates redundant codebase exploration
|
||||
|
||||
**Session Structure**:
|
||||
```
|
||||
```plaintext
|
||||
{projectRoot}/.workflow/.cycle/
|
||||
├── {cycleId}.json # Main state file
|
||||
├── {cycleId}.progress/
|
||||
@@ -156,7 +156,7 @@ event (phase advance / user resume)
|
||||
```
|
||||
|
||||
**Execution Flow**:
|
||||
```
|
||||
```plaintext
|
||||
Phase 1: Session initialization
|
||||
↓ cycleId, state, progressDir
|
||||
|
||||
@@ -190,13 +190,13 @@ Phase 4: Completion and summary
|
||||
**One-Liner**: Collaborative analysis — interactive analysis with documented discussions, inline exploration, and evolving understanding
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/analyze-with-file TOPIC="<question>"
|
||||
/analyze-with-file TOPIC="--depth=deep"
|
||||
```
|
||||
|
||||
**Core Workflow**:
|
||||
```
|
||||
```plaintext
|
||||
Topic → Explore → Discuss → Document → Refine → Conclude → (Optional) Quick Execute
|
||||
```
|
||||
|
||||
@@ -222,7 +222,7 @@ Topic → Explore → Discuss → Document → Refine → Conclude → (Optional
|
||||
**One-Liner**: Multi-perspective brainstorming — 4 perspectives (Product, Technical, Risk, User) parallel analysis
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/brainstorm-with-file TOPIC="<idea>"
|
||||
```
|
||||
|
||||
@@ -246,12 +246,12 @@ Topic → Explore → Discuss → Document → Refine → Conclude → (Optional
|
||||
**One-Liner**: Hypothesis-driven debugging — documented exploration, understanding evolution, analysis-assisted correction
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/debug-with-file BUG="<bug description>"
|
||||
```
|
||||
|
||||
**Core Workflow**:
|
||||
```
|
||||
```plaintext
|
||||
Explore → Document → Log → Analyze → Correct Understanding → Fix → Verify
|
||||
```
|
||||
|
||||
@@ -262,7 +262,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
- **Learning preservation**: Retain insights from failed attempts
|
||||
|
||||
**Session Folder Structure**:
|
||||
```
|
||||
```plaintext
|
||||
{projectRoot}/.workflow/.debug/DBG-{slug}-{date}/
|
||||
├── debug.log # NDJSON log (execution evidence)
|
||||
├── understanding.md # Exploration timeline + consolidated understanding
|
||||
@@ -283,7 +283,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Collaborative planning — multi-agent collaborative planning (alternative to team-planex)
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/collaborative-plan-with-file <task>
|
||||
```
|
||||
|
||||
@@ -299,7 +299,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Universal execution engine — alternative to workflow-execute
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/unified-execute-with-file <session>
|
||||
```
|
||||
|
||||
@@ -315,7 +315,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Requirement roadmap planning
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/roadmap-with-file <requirements>
|
||||
```
|
||||
|
||||
@@ -331,7 +331,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Review cycle (Codex version)
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/review-cycle <target>
|
||||
```
|
||||
|
||||
@@ -347,7 +347,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Test-fix workflow
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/workflow-test-fix-cycle <failing-tests>
|
||||
```
|
||||
|
||||
@@ -364,7 +364,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Intelligent code cleanup
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/clean <target>
|
||||
```
|
||||
|
||||
@@ -380,7 +380,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: CSV wave processing pipeline
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/csv-wave-pipeline <csv-file>
|
||||
```
|
||||
|
||||
@@ -396,7 +396,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Memory compression (Codex version)
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/memory-compact
|
||||
```
|
||||
|
||||
@@ -412,7 +412,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: CLI tool execution specification
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/ccw-cli-tools <command>
|
||||
```
|
||||
|
||||
@@ -428,7 +428,7 @@ Explore → Document → Log → Analyze → Correct Understanding → Fix → V
|
||||
**One-Liner**: Issue discovery
|
||||
|
||||
**Triggers**:
|
||||
```
|
||||
```shell
|
||||
/issue-discover <context>
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user