generate-documentation

Generate Documentation

Generate high-quality technical documentation for a file, folder, or project.

Input Parsing

Parse $ARGUMENTS to extract path and optional meta-instructions:

Format: <path> [-- <meta-instructions>]

Examples:
- /acc:generate-documentation ./
- /acc:generate-documentation src/ -- focus on API documentation
- /acc:generate-documentation ./ -- create architecture doc with C4 diagrams
- /acc:generate-documentation src/Domain/Order -- document only public interfaces
- /acc:generate-documentation ./ -- на русском языке

Parsing rules:

1. Split $ARGUMENTS by -- (space-dash-dash-space)
2. First part = path (required, default: current directory)
3. Second part = meta-instructions (optional, customization)

Target

• Path: First part of $ARGUMENTS (before --)
• Meta-instructions: Second part (after --) — use to customize output

If meta-instructions provided, adjust documentation to:

• Focus on specific documentation types
• Include/exclude certain sections
• Use specific diagram types
• Target specific audience
• Use specific language

Pre-flight Check

1. Verify the path exists:

   • If $ARGUMENTS is empty, ask user what they want to document
   • If path doesn't exist, report error and stop

2. Determine documentation type:

   • File → API documentation, code examples
   • Directory → README, architecture docs
   • Project root → Full documentation suite

Documentation Flow

/acc:generate-documentation <path>
    │
    ├─ Pre-flight: Validate path exists
    │
    ├─ Phase 1: Analyze project scope
    │   ├─ Read composer.json (if exists)
    │   ├─ Identify project type (library/app/API)
    │   └─ Determine audience
    │
    ├─ Phase 2: Task → acc:documentation-writer
    │   └─ Generate appropriate documentation
    │
    ├─ Phase 3: Task → acc:diagram-designer (if architecture docs)
    │   └─ Create Mermaid diagrams
    │
    └─ Output: Generated documentation files