Files
Claude-Code-Workflow/.claude/commands/memory/docs.md

30 KiB

name, description, argument-hint
name description argument-hint
docs Documentation planning and orchestration - creates structured documentation tasks for execution [path] [--tool <gemini|qwen|codex>] [--mode <full|partial>] [--cli-generate]

Documentation Workflow (/memory:docs)

Overview

Lightweight planner that analyzes project structure, decomposes documentation work into tasks, and generates execution plans. Does NOT generate documentation content itself - delegates to doc-generator agent.

Documentation Output: All generated documentation is placed in .workflow/docs/{project_name}/ directory with mirrored project structure. For example:

  • Project: my_app
  • Source: my_app/src/core/ → Docs: .workflow/docs/my_app/src/core/API.md
  • Source: my_app/src/modules/auth/ → Docs: .workflow/docs/my_app/src/modules/auth/API.md

Two Execution Modes:

  • Default: CLI analyzes in pre_analysis (MODE=analysis), agent writes docs in implementation_approach
  • --cli-generate: CLI generates docs in implementation_approach (MODE=write)

Path Mirroring Strategy

Principle: Documentation structure mirrors source code structure under project-specific directory.

Source Path Project Name Documentation Path
my_app/src/core/ my_app .workflow/docs/my_app/src/core/API.md
my_app/src/modules/auth/ my_app .workflow/docs/my_app/src/modules/auth/API.md
another_project/lib/utils/ another_project .workflow/docs/another_project/lib/utils/API.md

Benefits:

  • Easy to locate documentation for any source file
  • Maintains logical organization
  • Clear 1:1 mapping between code and docs
  • Supports any project structure (src/, lib/, packages/, etc.)

Parameters

/memory:docs [path] [--tool <gemini|qwen|codex>] [--mode <full|partial>] [--cli-generate]
  • path: Target directory (default: current directory)

    • Specifies the directory to generate documentation for
  • --mode: Documentation generation mode (default: full)

    • full: Complete documentation (modules + project README + ARCHITECTURE + EXAMPLES)
      • Level 1: Module tree documentation
      • Level 2: Project README.md
      • Level 3: ARCHITECTURE.md + EXAMPLES.md + HTTP API (optional)
    • partial: Module documentation only
      • Level 1: Module tree documentation (API.md + README.md)
      • Skips project-level documentation
  • --tool: CLI tool selection (default: gemini)

    • gemini: Comprehensive documentation, pattern recognition
    • qwen: Architecture analysis, system design focus
    • codex: Implementation validation, code quality
  • --cli-generate: Enable CLI-based documentation generation (optional)

    • When enabled: CLI generates docs with MODE=write in implementation_approach
    • When disabled (default): CLI analyzes with MODE=analysis in pre_analysis

Planning Workflow

Phase 1: Initialize Session

Step 1: Get Target Path and Project Name

# Get current directory as target path
bash(pwd)

# Get project name from current directory
bash(basename "$(pwd)")

# Get project root from git
bash(git rev-parse --show-toplevel 2>/dev/null || pwd)

# Generate timestamp for session ID
bash(date +%Y%m%d-%H%M%S)

Output:

  • target_path: /d/Claude_dms3
  • project_name: Claude_dms3
  • project_root: /d/Claude_dms3
  • timestamp: 20240120-143022

Step 2: Create Session Structure

# Create session directories (replace timestamp with actual value)
bash(mkdir -p .workflow/WFS-docs-20240120-143022/.task)
bash(mkdir -p .workflow/WFS-docs-20240120-143022/.process)
bash(mkdir -p .workflow/WFS-docs-20240120-143022/.summaries)

# Mark session as active
bash(touch .workflow/.active-WFS-docs-20240120-143022)

Step 3: Create Config File

# Create config.json with session info (replace values with actual data)
bash(echo '{"session_id":"WFS-docs-20240120-143022","timestamp":"2024-01-20T14:30:22+08:00","path":".","target_path":"/d/Claude_dms3","project_root":"/d/Claude_dms3","project_name":"Claude_dms3","mode":"full","tool":"gemini","cli_generate":false}' | jq '.' > .workflow/WFS-docs-20240120-143022/.process/config.json)

Output:

✓ Session initialized: WFS-docs-20240120-143022
✓ Target: /d/Claude_dms3
✓ Mode: full
✓ Tool: gemini, CLI generate: false

Phase 2: Analyze Structure

Smart filter: Auto-detect and skip tests/build/config/vendor based on project tech stack (Node.js/Python/Go/Rust/etc).

Step 1: Discover and Classify Folders

# Run analysis pipeline (module discovery + folder classification + smart filtering)
bash(~/.claude/scripts/get_modules_by_depth.sh | ~/.claude/scripts/classify-folders.sh > .workflow/WFS-docs-20240120/.process/folder-analysis.txt)

Output Sample (folder-analysis.txt):

./src/modules/auth|code|code:5|dirs:2
./src/modules/api|code|code:3|dirs:0
./src/utils|navigation|code:0|dirs:4

Auto-skipped:

  • Tests: **/test/**, **/*.test.*, **/__tests__/**
  • Build: **/node_modules/**, **/dist/**, **/build/**
  • Config: Root-level config files (package.json, tsconfig.json, etc)
  • Vendor: Language-specific dependency directories

Step 2: Extract Top-Level Directories

# Group folders by top-level directory
bash(awk -F'|' '{
  path = $1
  gsub(/^\.\//, "", path)
  split(path, parts, "/")
  if (length(parts) >= 2) print parts[1] "/" parts[2]
  else if (length(parts) == 1 && parts[1] != ".") print parts[1]
}' .workflow/WFS-docs-20240120/.process/folder-analysis.txt | sort -u > .workflow/WFS-docs-20240120/.process/top-level-dirs.txt)

Output (top-level-dirs.txt):

src/modules
src/utils
lib/core

Step 3: Generate Analysis Summary

# Calculate statistics
bash(
  total=$(wc -l < .workflow/WFS-docs-20240120/.process/folder-analysis.txt)
  code_count=$(grep '|code|' .workflow/WFS-docs-20240120/.process/folder-analysis.txt | wc -l)
  nav_count=$(grep '|navigation|' .workflow/WFS-docs-20240120/.process/folder-analysis.txt | wc -l)
  top_dirs=$(wc -l < .workflow/WFS-docs-20240120/.process/top-level-dirs.txt)

  echo "📊 Folder Analysis Complete:"
  echo "  - Total folders: $total"
  echo "  - Code folders: $code_count"
  echo "  - Navigation folders: $nav_count"
  echo "  - Top-level dirs: $top_dirs"
)

# Update config with statistics
bash(jq '. + {analysis: {total: "15", code: "8", navigation: "7", top_level: "3"}}' .workflow/WFS-docs-20240120/.process/config.json > .workflow/WFS-docs-20240120/.process/config.json.tmp && mv .workflow/WFS-docs-20240120/.process/config.json.tmp .workflow/WFS-docs-20240120/.process/config.json)

Phase 3: Detect Update Mode

Step 1: Get Project Name from Config

# Read project name from config
bash(jq -r '.project_name' .workflow/WFS-docs-20240120-143022/.process/config.json)

Output: Claude_dms3

Step 2: Count Existing Documentation

# Count existing docs (replace project_name with actual value)
bash(find .workflow/docs/Claude_dms3 -name "*.md" 2>/dev/null | wc -l || echo 0)

Output: 5 (existing docs) or 0 (no docs)

Step 3: List Existing Documentation Files

# List existing docs to file (replace project_name and session)
bash(find .workflow/docs/Claude_dms3 -name "*.md" 2>/dev/null > .workflow/WFS-docs-20240120-143022/.process/existing-docs.txt || touch .workflow/WFS-docs-20240120-143022/.process/existing-docs.txt)

# Display existing docs
bash(cat .workflow/WFS-docs-20240120-143022/.process/existing-docs.txt)

Output (existing-docs.txt):

.workflow/docs/Claude_dms3/src/modules/auth/API.md
.workflow/docs/Claude_dms3/src/modules/auth/README.md
.workflow/docs/Claude_dms3/lib/core/README.md
.workflow/docs/Claude_dms3/README.md

Step 4: Update Config with Update Status

# If existing_count > 0, update config with "update" mode (replace session and count)
bash(jq '. + {update_mode: "update", existing_docs: 5}' .workflow/WFS-docs-20240120-143022/.process/config.json > .workflow/WFS-docs-20240120-143022/.process/config.json.tmp && mv .workflow/WFS-docs-20240120-143022/.process/config.json.tmp .workflow/WFS-docs-20240120-143022/.process/config.json)

# Or if existing_count = 0, use "create" mode
bash(jq '. + {update_mode: "create", existing_docs: 0}' .workflow/WFS-docs-20240120-143022/.process/config.json > .workflow/WFS-docs-20240120-143022/.process/config.json.tmp && mv .workflow/WFS-docs-20240120-143022/.process/config.json.tmp .workflow/WFS-docs-20240120-143022/.process/config.json)

Step 5: Display Strategy Summary

# Read config values
bash(jq -r '.mode' .workflow/WFS-docs-20240120-143022/.process/config.json)
bash(jq -r '.update_mode' .workflow/WFS-docs-20240120-143022/.process/config.json)
bash(jq -r '.existing_docs' .workflow/WFS-docs-20240120-143022/.process/config.json)
bash(jq -r '.tool' .workflow/WFS-docs-20240120-143022/.process/config.json)
bash(jq -r '.cli_generate' .workflow/WFS-docs-20240120-143022/.process/config.json)
bash(jq -r '.target_path' .workflow/WFS-docs-20240120-143022/.process/config.json)

Phase 4: Decompose Tasks

Task Hierarchy

Level 1: Module Trees (always, parallel execution)
  ├─ IMPL-001: Document 'src/modules/'
  ├─ IMPL-002: Document 'src/utils/'
  └─ IMPL-003: Document 'lib/'

Level 2: Project README (mode=full only, depends on Level 1)
  └─ IMPL-004: Generate Project README

Level 3: Architecture & Examples (mode=full only, depends on Level 2)
  ├─ IMPL-005: Generate ARCHITECTURE.md + EXAMPLES.md
  └─ IMPL-006: Generate HTTP API (optional)

Step 1: Read Top-Level Directories

# Read top-level directories list
bash(cat .workflow/WFS-docs-20240120-143022/.process/top-level-dirs.txt)

Output:

src/modules
src/utils
lib

Step 2: Count Directories for Task Generation

# Count how many tasks to create
bash(wc -l < .workflow/WFS-docs-20240120-143022/.process/top-level-dirs.txt)

Output: 3 (will generate IMPL-001, IMPL-002, IMPL-003)

Step 3: Check Documentation Mode

# Check if full or partial mode
bash(jq -r '.mode' .workflow/WFS-docs-20240120-143022/.process/config.json)

Output: full or partial

Step 4: Check for HTTP API Endpoints (Optional)

# Search for API endpoint patterns
bash(grep -r "router\.|@Get\|@Post" src/ 2>/dev/null && echo "API_FOUND" || echo "NO_API")

Output: API_FOUND or NO_API

Task Generation Summary:

  • Partial mode: Generate only IMPL-001, IMPL-002, IMPL-003 (module trees)
  • Full mode without API: Generate IMPL-001 to IMPL-005
  • Full mode with API: Generate IMPL-001 to IMPL-006

Phase 5: Generate Task JSONs

Step 1: Read Configuration Values

# Read tool selection
bash(jq -r '.tool' .workflow/WFS-docs-20240120-143022/.process/config.json)

# Read cli_generate flag
bash(jq -r '.cli_generate' .workflow/WFS-docs-20240120-143022/.process/config.json)

# Read mode
bash(jq -r '.mode' .workflow/WFS-docs-20240120-143022/.process/config.json)

Output:

  • tool: gemini
  • cli_generate: false
  • mode: full

Step 2: Determine CLI Strategy

If cli_generate = false:

  • MODE: analysis
  • Placement: pre_analysis
  • Approval flag: (none)
  • Command pattern: cd dir && gemini -p "..."

If cli_generate = true:

  • MODE: write
  • Placement: implementation_approach
  • Approval flag: --approval-mode yolo
  • Command pattern: cd dir && gemini --approval-mode yolo -p "..."

If tool = codex:

  • Command pattern: codex -C dir --full-auto exec "..." --skip-git-repo-check -s danger-full-access

Step 3: Generate Task JSON Files

Tasks are generated based on:

  • Top-level directories from Phase 4
  • Configuration from config.json
  • Task templates (see Task Templates section below)

Each task JSON is written to .workflow/WFS-docs-20240120-143022/.task/IMPL-XXX.json

Task Templates

Level 1: Module Tree Task

Path Mapping:

  • Project: {project_name} (extracted from target_path)
  • Source: {project_name}/src/modules/
  • Output: .workflow/docs/{project_name}/src/modules/

Default Mode (cli_generate=false):

{
  "id": "IMPL-001",
  "title": "Document Module Tree: 'src/modules/'",
  "status": "pending",
  "meta": {
    "type": "docs-tree",
    "agent": "@doc-generator",
    "tool": "gemini",
    "cli_generate": false,
    "source_path": "src/modules",
    "output_path": ".workflow/docs/${project_name}/src/modules"
  },
  "context": {
    "requirements": [
      "Analyze source code in src/modules/",
      "Generate docs to .workflow/docs/${project_name}/src/modules/ (mirrored structure)",
      "For code folders: generate API.md + README.md",
      "For navigation folders: generate README.md only"
    ],
    "focus_paths": ["src/modules"],
    "folder_analysis_file": "${session_dir}/.process/folder-analysis.txt"
  },
  "flow_control": {
    "pre_analysis": [
      {
        "step": "load_existing_docs",
        "command": "bash(find .workflow/docs/${project_name}/${top_dir} -name '*.md' 2>/dev/null | xargs cat || echo 'No existing docs')",
        "output_to": "existing_module_docs"
      },
      {
        "step": "load_folder_analysis",
        "command": "bash(grep '^src/modules' ${session_dir}/.process/folder-analysis.txt)",
        "output_to": "target_folders"
      },
      {
        "step": "analyze_module_tree",
        "command": "bash(cd src/modules && gemini \"PURPOSE: Analyze module structure\\nTASK: Generate documentation outline\\nMODE: analysis\\nCONTEXT: @**/* [target_folders]\\nEXPECTED: Structure outline\\nRULES: Analyze only\")",
        "output_to": "tree_outline",
        "note": "CLI for analysis only"
      }
    ],
    "implementation_approach": [
      {
        "step": 1,
        "title": "Generate module tree documentation",
        "description": "Analyze source folders and generate docs to .workflow/docs/ with mirrored structure",
        "modification_points": [
          "Parse folder types from [target_folders]",
          "Parse structure from [tree_outline]",
          "For src/modules/auth/ → write to .workflow/docs/${project_name}/src/modules/auth/",
          "Generate API.md for code folders",
          "Generate README.md for all folders"
        ],
        "logic_flow": [
          "Parse [target_folders] to get folder types",
          "Parse [tree_outline] for structure",
          "For each folder in source:",
          "  - Map source_path to .workflow/docs/${project_name}/{source_path}",
          "  - If type == 'code': Generate API.md + README.md",
          "  - Elif type == 'navigation': Generate README.md only"
        ],
        "depends_on": [],
        "output": "module_docs"
      }
    ],
    "target_files": [
      ".workflow/docs/${project_name}/${top_dir}/*/API.md",
      ".workflow/docs/${project_name}/${top_dir}/*/README.md"
    ]
  }
}

CLI Generate Mode (cli_generate=true):

{
  "id": "IMPL-001",
  "title": "Document Module Tree: 'src/modules/'",
  "status": "pending",
  "meta": {
    "type": "docs-tree",
    "agent": "@doc-generator",
    "tool": "gemini",
    "cli_generate": true,
    "source_path": "src/modules",
    "output_path": ".workflow/docs/${project_name}/src/modules"
  },
  "context": {
    "requirements": [
      "Analyze source code in src/modules/",
      "Generate docs to .workflow/docs/${project_name}/src/modules/ (mirrored structure)",
      "CLI generates documentation files directly"
    ],
    "focus_paths": ["src/modules"]
  },
  "flow_control": {
    "pre_analysis": [
      {
        "step": "load_existing_docs",
        "command": "bash(find .workflow/docs/${project_name}/${top_dir} -name '*.md' 2>/dev/null | xargs cat || echo 'No existing docs')",
        "output_to": "existing_module_docs"
      },
      {
        "step": "load_folder_analysis",
        "command": "bash(grep '^src/modules' ${session_dir}/.process/folder-analysis.txt)",
        "output_to": "target_folders"
      }
    ],
    "implementation_approach": [
      {
        "step": 1,
        "title": "Parse folder analysis",
        "description": "Parse [target_folders] to get folder types and structure",
        "modification_points": ["Extract folder types", "Identify code vs navigation folders"],
        "logic_flow": ["Parse [target_folders] to get folder types", "Prepare folder list for CLI generation"],
        "depends_on": [],
        "output": "folder_types"
      },
      {
        "step": 2,
        "title": "Generate documentation via CLI",
        "description": "Call CLI to generate docs to .workflow/docs/ with mirrored structure using MODE=write",
        "modification_points": [
          "Execute CLI generation command",
          "Generate files to .workflow/docs/${project_name}/src/modules/ (mirrored path)",
          "Generate API.md and README.md files"
        ],
        "logic_flow": [
          "CLI analyzes source code in src/modules/",
          "CLI writes documentation to .workflow/docs/${project_name}/src/modules/",
          "Maintains directory structure mirroring"
        ],
        "command": "bash(cd src/modules && gemini --approval-mode yolo \"PURPOSE: Generate module docs\\nTASK: Create documentation files in .workflow/docs/${project_name}/src/modules/\\nMODE: write\\nCONTEXT: @**/* [target_folders] [existing_module_docs]\\nEXPECTED: API.md and README.md in .workflow/docs/${project_name}/src/modules/\\nRULES: Mirror source structure, generate complete docs\")",
        "depends_on": [1],
        "output": "generated_docs"
      }
    ],
    "target_files": [
      ".workflow/docs/${project_name}/${top_dir}/*/API.md",
      ".workflow/docs/${project_name}/${top_dir}/*/README.md"
    ]
  }
}

Level 2: Project README Task

Default Mode:

{
  "id": "IMPL-004",
  "title": "Generate Project README",
  "status": "pending",
  "depends_on": ["IMPL-001", "IMPL-002", "IMPL-003"],
  "meta": {
    "type": "docs",
    "agent": "@doc-generator",
    "tool": "gemini",
    "cli_generate": false
  },
  "flow_control": {
    "pre_analysis": [
      {
        "step": "load_existing_readme",
        "command": "bash(cat .workflow/docs/${project_name}/README.md 2>/dev/null || echo 'No existing README')",
        "output_to": "existing_readme"
      },
      {
        "step": "load_module_docs",
        "command": "bash(find .workflow/docs/${project_name} -type f -name '*.md' ! -path '.workflow/docs/${project_name}/README.md' ! -path '.workflow/docs/${project_name}/ARCHITECTURE.md' ! -path '.workflow/docs/${project_name}/EXAMPLES.md' ! -path '.workflow/docs/${project_name}/api/*' | xargs cat)",
        "output_to": "all_module_docs",
        "note": "Load all module docs from mirrored structure"
      },
      {
        "step": "analyze_project",
        "command": "bash(gemini \"PURPOSE: Analyze project structure\\nTASK: Extract overview from modules\\nMODE: analysis\\nCONTEXT: [all_module_docs]\\nEXPECTED: Project outline\")",
        "output_to": "project_outline"
      }
    ],
    "implementation_approach": [
      {
        "step": 1,
        "title": "Generate project README",
        "description": "Generate project README with navigation links while preserving existing user modifications",
        "modification_points": ["Parse [project_outline] and [all_module_docs]", "Generate project README structure", "Add navigation links to modules", "Preserve [existing_readme] user modifications"],
        "logic_flow": ["Parse [project_outline] and [all_module_docs]", "Generate project README with navigation links", "Preserve [existing_readme] user modifications"],
        "depends_on": [],
        "output": "project_readme"
      }
    ],
    "target_files": [".workflow/docs/${project_name}/README.md"]
  }
}

Level 3: Architecture & Examples Documentation Task

Default Mode:

{
  "id": "IMPL-005",
  "title": "Generate Architecture & Examples Documentation",
  "status": "pending",
  "depends_on": ["IMPL-004"],
  "meta": {
    "type": "docs",
    "agent": "@doc-generator",
    "tool": "gemini",
    "cli_generate": false
  },
  "flow_control": {
    "pre_analysis": [
      {
        "step": "load_existing_docs",
        "command": "bash(cat .workflow/docs/${project_name}/ARCHITECTURE.md 2>/dev/null || echo 'No existing ARCHITECTURE'; echo '---SEPARATOR---'; cat .workflow/docs/${project_name}/EXAMPLES.md 2>/dev/null || echo 'No existing EXAMPLES')",
        "output_to": "existing_arch_examples"
      },
      {
        "step": "load_all_docs",
        "command": "bash(cat .workflow/docs/${project_name}/README.md && find .workflow/docs/${project_name} -type f -name '*.md' ! -path '.workflow/docs/${project_name}/README.md' ! -path '.workflow/docs/${project_name}/ARCHITECTURE.md' ! -path '.workflow/docs/${project_name}/EXAMPLES.md' ! -path '.workflow/docs/${project_name}/api/*' | xargs cat)",
        "output_to": "all_docs",
        "note": "Load README + all module docs from mirrored structure"
      },
      {
        "step": "analyze_architecture_and_examples",
        "command": "bash(gemini \"PURPOSE: Analyze system architecture and generate examples\\nTASK: Synthesize architectural overview and usage patterns\\nMODE: analysis\\nCONTEXT: [all_docs]\\nEXPECTED: Architecture outline + Examples outline\")",
        "output_to": "arch_examples_outline"
      }
    ],
    "implementation_approach": [
      {
        "step": 1,
        "title": "Generate architecture and examples documentation",
        "description": "Generate ARCHITECTURE.md and EXAMPLES.md while preserving existing user modifications",
        "modification_points": [
          "Parse [arch_examples_outline] and [all_docs]",
          "Generate ARCHITECTURE.md structure with system design and patterns",
          "Generate EXAMPLES.md structure with code snippets and usage examples",
          "Preserve [existing_arch_examples] user modifications"
        ],
        "logic_flow": [
          "Parse [arch_examples_outline] and [all_docs]",
          "Generate ARCHITECTURE.md with system design",
          "Generate EXAMPLES.md with code snippets",
          "Preserve [existing_arch_examples] modifications"
        ],
        "depends_on": [],
        "output": "arch_examples_docs"
      }
    ],
    "target_files": [
      ".workflow/docs/${project_name}/ARCHITECTURE.md",
      ".workflow/docs/${project_name}/EXAMPLES.md"
    ]
  }
}

Level 3: HTTP API Documentation Task (Optional)

Default Mode:

{
  "id": "IMPL-006",
  "title": "Generate HTTP API Documentation",
  "status": "pending",
  "depends_on": ["IMPL-004"],
  "meta": {
    "type": "docs",
    "agent": "@doc-generator",
    "tool": "gemini",
    "cli_generate": false
  },
  "flow_control": {
    "pre_analysis": [
      {
        "step": "discover_api_endpoints",
        "command": "bash(rg 'router\\.| @(Get|Post)' -g '*.{ts,js}')",
        "output_to": "endpoint_discovery"
      },
      {
        "step": "load_existing_api_docs",
        "command": "bash(cat .workflow/docs/${project_name}/api/README.md 2>/dev/null || echo 'No existing API docs')",
        "output_to": "existing_api_docs"
      },
      {
        "step": "analyze_api",
        "command": "bash(gemini \"PURPOSE: Document HTTP API\\nTASK: Analyze API endpoints\\nMODE: analysis\\nCONTEXT: @src/api/**/* [endpoint_discovery]\\nEXPECTED: API outline\")",
        "output_to": "api_outline"
      }
    ],
    "implementation_approach": [
      {
        "step": 1,
        "title": "Generate HTTP API documentation",
        "description": "Generate HTTP API documentation while preserving existing user modifications",
        "modification_points": ["Parse [api_outline] and [endpoint_discovery]", "Generate HTTP API documentation", "Document endpoints and request/response formats", "Preserve [existing_api_docs] modifications"],
        "logic_flow": ["Parse [api_outline] and [endpoint_discovery]", "Generate HTTP API documentation", "Preserve [existing_api_docs] modifications"],
        "depends_on": [],
        "output": "api_docs"
      }
    ],
    "target_files": [".workflow/docs/${project_name}/api/README.md"]
  }
}

Session Structure

.workflow/
├── .active-WFS-docs-20240120-143022        # Active session marker
└── WFS-docs-20240120-143022/
    ├── IMPL_PLAN.md                         # Implementation plan
    ├── TODO_LIST.md                         # Progress tracker
    ├── .process/
    │   ├── config.json                      # Single config (all settings + stats)
    │   ├── folder-analysis.txt              # Folder classification results
    │   ├── top-level-dirs.txt               # Top-level directory list
    │   └── existing-docs.txt                # Existing documentation paths
    └── .task/
        ├── IMPL-001.json                    # Module tree task
        ├── IMPL-002.json                    # Module tree task
        ├── IMPL-003.json                    # Module tree task
        ├── IMPL-004.json                    # Project README (full mode)
        ├── IMPL-005.json                    # ARCHITECTURE.md + EXAMPLES.md (full mode)
        └── IMPL-006.json                    # HTTP API docs (optional)

Config File Structure (config.json):

{
  "session_id": "WFS-docs-20240120-143022",
  "timestamp": "2024-01-20T14:30:22+08:00",
  "path": ".",
  "target_path": "/home/user/projects/my_app",
  "project_root": "/home/user/projects",
  "project_name": "my_app",
  "mode": "full",
  "tool": "gemini",
  "cli_generate": false,
  "update_mode": "update",
  "existing_docs": 5,
  "analysis": {
    "total": "15",
    "code": "8",
    "navigation": "7",
    "top_level": "3"
  }
}

Generated Documentation

Structure mirrors project source directories under project-specific folder:

.workflow/docs/
└── {project_name}/                    # Project-specific root (e.g., my_app/)
    ├── src/                           # Mirrors src/ directory
    │   ├── modules/                   # Level 1 output
    │   │   ├── README.md              # Navigation for src/modules/
    │   │   ├── auth/
    │   │   │   ├── API.md             # Auth module API signatures
    │   │   │   ├── README.md          # Auth module documentation
    │   │   │   └── middleware/
    │   │   │       ├── API.md         # Middleware API
    │   │   │       └── README.md      # Middleware docs
    │   │   └── api/
    │   │       ├── API.md             # API module signatures
    │   │       └── README.md          # API module docs
    │   └── utils/                     # Level 1 output
    │       └── README.md              # Utils navigation
    ├── lib/                           # Mirrors lib/ directory
    │   └── core/
    │       ├── API.md
    │       └── README.md
    ├── README.md                      # Level 2 output (project root only)
    ├── ARCHITECTURE.md                # Level 3 output (project root only)
    ├── EXAMPLES.md                    # Level 3 output (project root only)
    └── api/                           # Level 3 output (optional)
        └── README.md                  # HTTP API reference

Execution Commands

# Execute entire workflow (auto-discovers active session)
/workflow:execute

# Or specify session
/workflow:execute --resume-session="WFS-docs-yyyymmdd-hhmmss"

# Individual task execution (if needed)
/task:execute IMPL-001

Simple Bash Commands

Session Management

# Generate timestamp
bash(date +%Y%m%d-%H%M%S)

# Create session directories (replace timestamp)
bash(mkdir -p .workflow/WFS-docs-20240120-143022/.task)
bash(mkdir -p .workflow/WFS-docs-20240120-143022/.process)
bash(mkdir -p .workflow/WFS-docs-20240120-143022/.summaries)

# Mark as active
bash(touch .workflow/.active-WFS-docs-20240120-143022)

# Get project name
bash(basename "$(pwd)")

# Create config (replace values)
bash(echo '{"session_id":"WFS-docs-20240120-143022","timestamp":"2024-01-20T14:30:22+08:00","path":".","target_path":"/d/project","project_name":"project","mode":"full","tool":"gemini","cli_generate":false}' | jq '.' > .workflow/WFS-docs-20240120-143022/.process/config.json)

# Read session config
bash(cat .workflow/WFS-docs-20240120-143022/.process/config.json)

# Extract config values
bash(jq -r '.tool' .workflow/WFS-docs-20240120-143022/.process/config.json)
bash(jq -r '.mode' .workflow/WFS-docs-20240120-143022/.process/config.json)
bash(jq -r '.project_name' .workflow/WFS-docs-20240120-143022/.process/config.json)

# List session tasks
bash(ls .workflow/WFS-docs-20240120-143022/.task/*.json)

Analysis Commands

# Discover and classify folders
bash(~/.claude/scripts/get_modules_by_depth.sh | ~/.claude/scripts/classify-folders.sh > .workflow/WFS-docs-20240120-143022/.process/folder-analysis.txt)

# Count existing docs (replace project_name)
bash(find .workflow/docs/my_project -name "*.md" 2>/dev/null | wc -l || echo 0)

# List existing documentation (replace project_name)
bash(find .workflow/docs/my_project -name "*.md" 2>/dev/null || echo "No docs found")

# Check if docs directory exists
bash(test -d .workflow/docs/my_project && echo "exists" || echo "not exists")

Template Reference

Available Templates:

  • api.txt: Unified template for Code API (Part A) and HTTP API (Part B)
  • module-readme.txt: Module purpose, usage, dependencies
  • folder-navigation.txt: Navigation README for folders with subdirectories
  • project-readme.txt: Project overview, getting started, module navigation
  • project-architecture.txt: System structure, module map, design patterns
  • project-examples.txt: End-to-end usage examples

Template Location: ~/.claude/workflows/cli-templates/prompts/documentation/

CLI Generate Mode Summary

Mode CLI Placement CLI MODE Agent Role
Default pre_analysis analysis Generates documentation files
--cli-generate implementation_approach write Validates and coordinates CLI output
  • /workflow:execute - Execute documentation tasks
  • /workflow:status - View task progress
  • /workflow:session:complete - Mark session complete