Skip to content

Commit 4a89f62

Browse files
author
catlog22
committed
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.
1 parent b0bfdb9 commit 4a89f62

51 files changed

Lines changed: 741 additions & 619 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/commands/cli/cli-init.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ Creates tool-specific configuration directories:
3333
- `.gemini/settings.json`:
3434
```json
3535
{
36-
"contextfilename": ["CLAUDE.md","GEMINI.md"]
36+
"contextfilename": "CLAUDE.md"
3737
}
3838
```
3939

4040
**For Qwen** (`.qwen/`):
4141
- `.qwen/settings.json`:
4242
```json
4343
{
44-
"contextfilename": ["CLAUDE.md","QWEN.md"]
44+
"contextfilename": "CLAUDE.md"
4545
}
4646
```
4747

docs/COMMAND_SPEC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22
# Claude Code Workflow (CCW) - Command Specification
33

4-
**Version**: 6.2.0
5-
**Updated**: 2025-12-20
4+
**Version**: 7.0.6
5+
**Updated**: 2026-02-28
66

77
## 1. Introduction
88

docs/commands/claude/cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
**Function**: Generate `.gemini/` and `.qwen/` configuration directories based on workspace tech detection, including settings.json and ignore files.
2727

2828
**Syntax**:
29-
```
29+
```bash
3030
/cli:cli-init [--tool gemini|qwen|all] [--output path] [--preview]
3131
```
3232

@@ -36,7 +36,7 @@
3636
- `--preview`: Preview mode (don't actually create)
3737

3838
**Generated File Structure**:
39-
```
39+
```plaintext
4040
.gemini/
4141
├── settings.json # Gemini configuration
4242
└── ignore # Ignore patterns
@@ -75,7 +75,7 @@
7575
**Function**: Interactive code review using Codex CLI via ccw endpoint, supporting configurable review targets, models, and custom instructions.
7676

7777
**Syntax**:
78-
```
78+
```bash
7979
/cli:codex-review [--uncommitted|--base <branch>|--commit <sha>] [--model <model>] [--title <title>] [prompt]
8080
```
8181

docs/commands/claude/core-orchestration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
**Function**: Main workflow orchestrator - intent analysis -> workflow selection -> command chain execution
1919

2020
**Syntax**:
21-
```
21+
```bash
2222
/ccw "task description"
2323
```
2424

@@ -80,7 +80,7 @@ graph TD
8080
**Function**: Command orchestration tool - analyze tasks, recommend command chains, sequential execution, state persistence
8181

8282
**Syntax**:
83-
```
83+
```bash
8484
/ccw-coordinator "task description"
8585
```
8686

docs/commands/claude/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| **Core Orchestration** | 2 | Main workflow orchestrators (ccw, ccw-coordinator) |
1212
| **Workflow** | 20+ | Planning, execution, review, TDD, testing workflows |
1313
| **Session Management** | 6 | Session creation, listing, resuming, completion |
14-
| **Issue Workflow** | 7 | Issue discovery, planning, queue, execution |
14+
| **Issue Workflow** | 8 | Issue discovery, planning, queue, execution |
1515
| **Memory** | 8 | Memory capture, update, document generation |
1616
| **CLI Tools** | 2 | CLI initialization, Codex review |
1717
| **UI Design** | 10 | UI design prototype generation, style extraction |
@@ -52,6 +52,7 @@
5252
| [`/workflow:session:start`](./session.md#start) | Discover existing sessions or start new workflow session | Intermediate |
5353
| [`/workflow:session:list`](./session.md#list) | List all workflow sessions | Beginner |
5454
| [`/workflow:session:resume`](./session.md#resume) | Resume most recently paused workflow session | Intermediate |
55+
| [`/workflow:session:sync`](./session.md#sync) | Quick-sync session work to specs and project-tech | Intermediate |
5556
| [`/workflow:session:complete`](./session.md#complete) | Mark active workflow session as completed | Intermediate |
5657
| [`/workflow:session:solidify`](./session.md#solidify) | Crystallize session learnings into project guidelines | Intermediate |
5758

@@ -62,6 +63,7 @@
6263
| [`/issue:new`](./issue.md#new) | Create structured issue from GitHub URL or text description | Intermediate |
6364
| [`/issue:discover`](./issue.md#discover) | Discover potential issues from multiple perspectives | Intermediate |
6465
| [`/issue:discover-by-prompt`](./issue.md#discover-by-prompt) | Discover issues via user prompt | Intermediate |
66+
| [`/issue:from-brainstorm`](./issue.md#from-brainstorm) | Convert brainstorm session ideas into issue with executable solution | Intermediate |
6567
| [`/issue:plan`](./issue.md#plan) | Batch plan issue solutions | Intermediate |
6668
| [`/issue:queue`](./issue.md#queue) | Form execution queue | Intermediate |
6769
| [`/issue:execute`](./issue.md#execute) | Execute queue | Intermediate |
@@ -73,7 +75,7 @@
7375
|---------|----------|------------|
7476
| [`/memory:compact`](./memory.md#compact) | Compress current session memory to structured text | Intermediate |
7577
| [`/memory:tips`](./memory.md#tips) | Quick note-taking | Beginner |
76-
| [`/memory:load`](./memory.md#load) | Load task context via CLI project analysis | Intermediate |
78+
| [`/memory:prepare`](./memory.md#prepare) | Load task context via CLI project analysis | Intermediate |
7779
| [`/memory:update-full`](./memory.md#update-full) | Update all CLAUDE.md files | Intermediate |
7880
| [`/memory:update-related`](./memory.md#update-related) | Update CLAUDE.md for git-changed modules | Intermediate |
7981
| [`/memory:docs-full-cli`](./memory.md#docs-full-cli) | Generate full project documentation using CLI | Intermediate |

docs/commands/claude/issue.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
**Function**: Create structured issue from GitHub URL or text description, supporting requirement clarity detection.
3333

3434
**Syntax**:
35-
```
35+
```bash
3636
/issue:new [-y|--yes] <github-url | text description> [--priority 1-5]
3737
```
3838

@@ -92,7 +92,7 @@ interface Issue {
9292
**Function**: Discover potential issues from multiple perspectives (Bug, UX, Test, Quality, Security, Performance, Maintainability, Best Practices).
9393

9494
**Syntax**:
95-
```
95+
```bash
9696
/issue:discover [-y|--yes] <path pattern> [--perspectives=bug,ux,...] [--external]
9797
```
9898

@@ -125,7 +125,7 @@ interface Issue {
125125
**Function**: Discover issues via user prompt, using Gemini-planned iterative multi-agent exploration, supporting cross-module comparison.
126126

127127
**Syntax**:
128-
```
128+
```bash
129129
/issue:discover-by-prompt [-y|--yes] <prompt> [--scope=src/**] [--depth=standard|deep] [--max-iterations=5]
130130
```
131131

@@ -151,7 +151,7 @@ interface Issue {
151151
**Function**: Batch plan issue solutions, using issue-plan-agent (explore + plan closed loop).
152152

153153
**Syntax**:
154-
```
154+
```bash
155155
/issue:plan [-y|--yes] --all-pending <issue-id>[,<issue-id>,...] [--batch-size 3]
156156
```
157157

@@ -176,7 +176,7 @@ interface Issue {
176176
**Function**: Form execution queue from bound solutions, using issue-queue-agent (solution level).
177177

178178
**Syntax**:
179-
```
179+
```bash
180180
/issue:queue [-y|--yes] [--queues <n>] [--issue <id>]
181181
```
182182

@@ -201,7 +201,7 @@ interface Issue {
201201
**Function**: Execute queue, using DAG parallel orchestration (one commit per solution).
202202

203203
**Syntax**:
204-
```
204+
```bash
205205
/issue:execute [-y|--yes] --queue <queue-id> [--worktree [<existing-path>]]
206206
```
207207
@@ -223,7 +223,7 @@ interface Issue {
223223
**Function**: Convert planning artifact (lite-plan, workflow session, markdown) to issue solution.
224224
225225
**Syntax**:
226-
```
226+
```bash
227227
/issue:convert-to-plan [-y|--yes] [--issue <id>] [--supplement] <source>
228228
```
229229
@@ -253,7 +253,7 @@ interface Issue {
253253
**Function**: Convert brainstorm session ideas to issues and generate executable solutions.
254254
255255
**Syntax**:
256-
```
256+
```bash
257257
/issue:from-brainstorm SESSION="session-id" [--idea=<index>] [--auto] [-y|--yes]
258258
```
259259

docs/commands/claude/memory.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
|---------|----------|--------|
2020
| [`compact`](#compact) | Compress current session memory to structured text | `/memory:compact [optional: session description]` |
2121
| [`tips`](#tips) | Quick note-taking | `/memory:tips <note content> [--tag tags] [--context context]` |
22-
| [`load`](#load) | Load task context via CLI project analysis | `/memory:load [--tool gemini\|qwen] "task context description"` |
22+
| [`prepare`](#prepare) | Load task context via CLI project analysis | `/memory:prepare [--tool gemini\|qwen] "task context description"` |
2323
| [`update-full`](#update-full) | Update all CLAUDE.md files | `/memory:update-full [--tool gemini\|qwen\|codex] [--path directory]` |
2424
| [`update-related`](#update-related) | Update CLAUDE.md for git-changed modules | `/memory:update-related [--tool gemini\|qwen\|codex]` |
2525
| [`docs-full-cli`](#docs-full-cli) | Generate full project documentation using CLI | `/memory:docs-full-cli [path] [--tool tool]` |
@@ -33,7 +33,7 @@
3333
**Function**: Compress current session memory to structured text, extracting objectives, plans, files, decisions, constraints, and state, saving via MCP core_memory tool.
3434

3535
**Syntax**:
36-
```
36+
```bash
3737
/memory:compact [optional: session description]
3838
```
3939

@@ -59,7 +59,7 @@
5959
**Function**: Quick note-taking command, capturing thoughts, snippets, reminders, and insights for future reference.
6060

6161
**Syntax**:
62-
```
62+
```bash
6363
/memory:tips <note content> [--tag <tag1,tag2>] [--context <context>]
6464
```
6565

@@ -79,13 +79,13 @@
7979
/memory:tips "use Redis to cache user sessions" --context "login optimization"
8080
```
8181

82-
### load
82+
### prepare
8383

8484
**Function**: Delegate to universal-executor agent, analyzing project via Gemini/Qwen CLI and returning JSON core content package for task context.
8585

8686
**Syntax**:
87-
```
88-
/memory:load [--tool gemini|qwen] "task context description"
87+
```bash
88+
/memory:prepare [--tool gemini|qwen] "task context description"
8989
```
9090

9191
**Options**:
@@ -96,18 +96,18 @@
9696
**Examples**:
9797
```bash
9898
# Use default tool
99-
/memory:load "user authentication module"
99+
/memory:prepare "user authentication module"
100100

101101
# Specify tool
102-
/memory:load --tool gemini "payment system architecture"
102+
/memory:prepare --tool gemini "payment system architecture"
103103
```
104104

105105
### update-full
106106

107107
**Function**: Update all CLAUDE.md files, using layer-based execution (Layer 3->1), batch agent processing (4 modules/agent), and gemini->qwen->codex fallback.
108108

109109
**Syntax**:
110-
```
110+
```bash
111111
/memory:update-full [--tool gemini|qwen|codex] [--path <directory>]
112112
```
113113

@@ -137,7 +137,7 @@
137137
**Function**: Update CLAUDE.md files for git-changed modules, using batch agent execution (4 modules/agent) and gemini->qwen->codex fallback.
138138

139139
**Syntax**:
140-
```
140+
```bash
141141
/memory:update-related [--tool gemini|qwen|codex]
142142
```
143143

@@ -158,7 +158,7 @@
158158
**Function**: Generate full project documentation using CLI (Layer 3->1), batch agent processing (4 modules/agent), gemini->qwen->codex fallback, direct parallel for <20 modules.
159159

160160
**Syntax**:
161-
```
161+
```bash
162162
/memory:docs-full-cli [path] [--tool <gemini|qwen|codex>]
163163
```
164164

@@ -179,7 +179,7 @@
179179
**Function**: Generate documentation for git-changed modules using CLI, batch agent processing (4 modules/agent), gemini->qwen->codex fallback, direct execution for <15 modules.
180180

181181
**Syntax**:
182-
```
182+
```bash
183183
/memory:docs-related-cli [--tool <gemini|qwen|codex>]
184184
```
185185

@@ -197,7 +197,7 @@
197197
**Function**: Generate SKILL memory package from style reference, facilitating loading and consistent design system usage.
198198

199199
**Syntax**:
200-
```
200+
```bash
201201
/memory:style-skill-memory [package-name] [--regenerate]
202202
```
203203

0 commit comments

Comments
 (0)