when-documenting-code-use-doc-generator

# When Documenting Code - Use Doc Generator ## Overview This skill provides automated, comprehensive documentation generation for codebases. It analyzes code structure, generates API documentation, creates README files, adds inline comments, and produces architecture diagrams using evidence-based documentation patterns. ## Core Capabilities 1. **Code Analysis**: Extract APIs, functions, classes, types, and dependencies 2. **API Documentation**: Generate OpenAPI, JSDoc, TypeDoc, and Python docstrings 3. **README Generation**: Create comprehensive project documentation 4. **Inline Comments**: Add missing documentation with context-aware comments 5. **Diagram Generation**: Produce architecture and flow diagrams (Graphviz, Mermaid) ## SPARC Methodology: Documentation Generation ### Phase 1: SPECIFICATION - Analyze Documentation Requirements **Objective**: Understand the codebase structure and documentation needs **Actions**: 1. Scan project structure and identify file types 2. Detect programming languages and frameworks 3. Identify existing documentation (README, API docs, comments) 4. Analyze documentation gaps and missing coverage 5. Determine documentation standards (JSDoc, TSDoc, Python docstrings) **Deliverables**: - Project structure analysis - Documentation gap report - Recommended documentation strategy - Style guide selection **Agent**: `code-analyzer` **Example Analysis**: ``` Project: express-api-server Languages: JavaScript (TypeScript), 85% | JSON 10% | Ma...