[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M6ESTFV7F3HA2R8PYY5XDB28":3,"skill-same:01M6ESTFV7F3HA2R8PYY5XDB28":132},{"skillNo":4,"name":5,"nameZh":6,"description":7,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":16,"categories":17,"keywords":31,"publishedAt":52,"linkOnly":53,"markdownContent":54,"markdownBody":55,"frontMatter":56,"refName":71,"commitSha":72,"skillDirectory":73,"forksCount":74,"repositoryHtmlUrl":75,"repositoryHomepageUrl":76,"ownerHtmlUrl":77,"ownerBlogUrl":6,"ownerDescription":78,"updatedAt":79,"install":80,"resources":93},"01M6ESTFV7F3HA2R8PYY5XDB28","when-documenting-code-use-doc-generator",null,"Automated comprehensive code documentation generation with API docs, README files, inline comments, and architecture diagrams","ComeOnOliver\u002Fskillshub","ComeOnOliver","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F43215937?v=4","01M6E5JNFECJAAVFE0W7SMWWD2","Haoran Shu","01M6E5JNNDQS7AJZDYFQ8TPZCK",66,"MIT","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002FSKILL.md",[18,23,26],{"categoryNo":19,"categoryName":20,"taxonomyType":21,"taxonomyTypeDesc":22},"01JBSEEDCAT000000000000010","后端与接口","SCENARIO","使用场景",{"categoryNo":24,"categoryName":25,"taxonomyType":21,"taxonomyTypeDesc":22},"01JBSEEDCAT000000000000023","Skill与智能体开发",{"categoryNo":27,"categoryName":28,"taxonomyType":29,"taxonomyTypeDesc":30},"01JBSEEDCAT000000000000030","开发工程师","PROFESSION","适用职业",[32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51],"when documenting code use doc generator","doc generator","code","doc","use","write","api-docs","add","generate documentation","document","files","diagrams","architecture","README","template","api","generate","create","architecture diagrams","documentation","2026-11-10 10:12:30",false,"---\nname: when-documenting-code-use-doc-generator\nversion: 1.0.0\ndescription: Automated comprehensive code documentation generation with API docs, README files, inline comments, and architecture diagrams\ntriggers:\n  - \"generate documentation\"\n  - \"create API docs\"\n  - \"write README\"\n  - \"add comments\"\n  - \"document this code\"\nagents:\n  - code-analyzer\n  - base-template-generator\ncomplexity: medium\ntags: [documentation, api-docs, readme, comments, diagrams, automation]\n---\n\n# When Documenting Code - Use Doc Generator\n\n## Overview\n\nThis 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.\n\n## Core Capabilities\n\n1. **Code Analysis**: Extract APIs, functions, classes, types, and dependencies\n2. **API Documentation**: Generate OpenAPI, JSDoc, TypeDoc, and Python docstrings\n3. **README Generation**: Create comprehensive project documentation\n4. **Inline Comments**: Add missing documentation with context-aware comments\n5. **Diagram Generation**: Produce architecture and flow diagrams (Graphviz, Mermaid)\n\n## SPARC Methodology: Documentation Generation\n\n### Phase 1: SPECIFICATION - Analyze Documentation Requirements\n\n**Objective**: Understand the codebase structure and documentation needs\n\n**Actions**:\n1. Scan project structure and identify file types\n2. Detect programming languages and frameworks\n3. Identify existing documentation (README, API docs, comments)\n4. Analyze documentation gaps and missing coverage\n5. Determine documentation standards (JSDoc, TSDoc, Python docstrings)\n\n**Deliverables**:\n- Project structure analysis\n- Documentation gap report\n- Recommended documentation strategy\n- Style guide selection\n\n**Agent**: `code-analyzer`\n\n**Example Analysis**:\n```\nProject: express-api-server\nLanguages: JavaScript (TypeScript), 85% | JSON 10% | Markdown 5%\nFrameworks: Express.js, Jest\nCurrent Documentation:\n  - README.md: Exists (outdated, 3 months old)\n  - API Docs: None\n  - Inline Comments: 12% coverage\n  - Type Definitions: 45% coverage\n\nGaps Identified:\n  - ❌ No API documentation (12 endpoints undocumented)\n  - ❌ Missing installation instructions\n  - ❌ No architecture diagrams\n  - ⚠️  Low inline comment coverage\n  - ✅ Package.json well-documented\n\nRecommended Strategy:\n  1. Generate OpenAPI 3.0 spec for REST API\n  2. Add JSDoc comments to all public functions\n  3. Create comprehensive README with badges\n  4. Generate architecture diagram (system overview)\n  5. Add usage examples for main features\n```\n\n### Phase 2: PSEUDOCODE - Design Documentation Structure\n\n**Objective**: Plan documentation hierarchy and templates\n\n**Actions**:\n1. Design documentation structure (README, API, guides)\n2. Define comment style and conventions\n3. Create templates for each documentation type\n4. Plan diagram types and structure\n5. Define metadata and frontmatter standards\n\n**Deliverables**:\n- Documentation structure outline\n- Template designs for each type\n- Comment convention guide\n- Diagram specifications\n\n**Example Structure**:\n```\nDocumentation Hierarchy:\n\ndocs\u002F\n├── README.md                 # Project overview\n├── INSTALLATION.md          # Setup guide\n├── API.md                   # API reference\n├── ARCHITECTURE.md          # System design\n├── CONTRIBUTING.md          # Contribution guide\n├── diagrams\u002F\n│   ├── system-overview.svg  # High-level architecture\n│   ├── data-flow.svg        # Data flow diagram\n│   └── api-endpoints.svg    # API structure\n└── examples\u002F\n    ├── basic-usage.md\n    └── advanced-features.md\n\nComment Standards:\n- JSDoc for all exported functions\n- TypeDoc for TypeScript interfaces\n- File header with purpose and author\n- Inline comments for complex logic only\n\nAPI Documentation:\n- OpenAPI 3.0 specification\n- Example requests\u002Fresponses\n- Error code documentation\n- Authentication guide\n```\n\n### Phase 3: ARCHITECTURE - Define Generation Pipeline\n\n**Objective**: Design the documentation generation workflow\n\n**Actions**:\n1. Define code parsing strategy (AST, regex, static analysis)\n2. Design template engine for documentation generation\n3. Plan diagram generation pipeline (Graphviz\u002FMermaid)\n4. Define validation and quality checks\n5. Create update and versioning strategy\n\n**Deliverables**:\n- Documentation generation pipeline\n- Parser and extractor design\n- Template rendering engine\n- Validation rules\n\n**Pipeline Architecture**:\n```\n┌─────────────────┐\n│  Source Code    │\n│  Repository     │\n└────────┬────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Code Analyzer          │\n│  - AST Parsing          │\n│  - Extract Functions    │\n│  - Extract Types        │\n│  - Detect Patterns      │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Documentation Engine   │\n│  ├─ API Generator       │\n│  ├─ README Generator    │\n│  ├─ Comment Generator   │\n│  └─ Diagram Generator   │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Template Renderer      │\n│  - Mustache\u002FHandlebars  │\n│  - Markdown Formatting  │\n│  - Syntax Highlighting  │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Validator              │\n│  - Link Checking        │\n│  - Spelling             │\n│  - Completeness         │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Output                 │\n│  - docs\u002F                │\n│  - Inline Comments      │\n│  - Generated Diagrams   │\n└─────────────────────────┘\n```\n\n### Phase 4: REFINEMENT - Generate and Validate Documentation\n\n**Objective**: Execute documentation generation with quality checks\n\n**Actions**:\n1. Parse source code and extract documentation targets\n2. Generate API documentation from code signatures\n3. Create README from templates and project metadata\n4. Add inline comments to undocumented code\n5. Generate architecture and flow diagrams\n6. Validate completeness and accuracy\n7. Check links and references\n8. Format and style according to standards\n\n**Deliverables**:\n- Complete API documentation\n- Comprehensive README\n- Inline code comments\n- Architecture diagrams\n- Validation report\n\n**Generation Examples**:\n\n**Before (Undocumented Function)**:\n```javascript\nfunction calculateDiscount(price, customerType, quantity) {\n  const baseDiscount = customerType === 'premium' ? 0.15 : 0.05;\n  const volumeDiscount = quantity > 100 ? 0.1 : quantity > 50 ? 0.05 : 0;\n  return price * (1 - baseDiscount - volumeDiscount);\n}\n```\n\n**After (With JSDoc)**:\n```javascript\n\u002F**\n * Calculates the final price after applying customer and volume discounts\n *\n * @param {number} price - The original price before discounts\n * @param {('standard'|'premium')} customerType - Customer tier level\n * @param {number} quantity - Number of items purchased\n * @returns {number} The discounted price\n *\n * @example\n * \u002F\u002F Premium customer buying 60 items at $100 each\n * calculateDiscount(100, 'premium', 60);\n * \u002F\u002F Returns: 80 (15% customer + 5% volume discount)\n *\n * @see {@link https:\u002F\u002Fdocs.example.com\u002Fpricing|Pricing Documentation}\n *\u002F\nfunction calculateDiscount(price, customerType, quantity) {\n  \u002F\u002F Premium customers receive 15% base discount, standard customers 5%\n  const baseDiscount = customerType === 'premium' ? 0.15 : 0.05;\n\n  \u002F\u002F Volume discounts: 10% for 100+, 5% for 50+, 0% otherwise\n  const volumeDiscount = quantity > 100 ? 0.1 : quantity > 50 ? 0.05 : 0;\n\n  return price * (1 - baseDiscount - volumeDiscount);\n}\n```\n\n**API Documentation Generation**:\n```yaml\n# Generated OpenAPI 3.0 Specification\nopenapi: 3.0.0\ninfo:\n  title: E-commerce API\n  version: 1.0.0\n  description: REST API for e-commerce platform with pricing and inventory\n\npaths:\n  \u002Fapi\u002Fv1\u002Fproducts\u002F{id}\u002Fprice:\n    get:\n      summary: Calculate product price with discounts\n      description: Returns the final price after applying customer tier and volume discounts\n      operationId: calculateProductPrice\n      tags:\n        - Pricing\n      parameters:\n        - name: id\n          in: path\n          required: true\n          schema:\n            type: string\n          description: Product ID\n        - name: quantity\n          in: query\n          required: true\n          schema:\n            type: integer\n            minimum: 1\n          description: Quantity to purchase\n        - name: customerType\n          in: query\n          required: false\n          schema:\n            type: string\n            enum: [standard, premium]\n            default: standard\n          description: Customer tier level\n      responses:\n        '200':\n          description: Price calculated successfully\n          content:\n            application\u002Fjson:\n              schema:\n                type: object\n                properties:\n                  originalPrice:\n                    type: number\n                    example: 100.00\n                  discountedPrice:\n                    type: number\n                    example: 80.00\n                  discountsApplied:\n                    type: array\n                    items:\n                      type: object\n                      properties:\n                        type:\n                          type: string\n                          enum: [customer, volume]\n                        percentage:\n                          type: number\n                          example: 0.15\n        '404':\n          description: Product not found\n```\n\n**README Generation**:\n```markdown\n# E-commerce API Server\n\n[![Build Status](https:\u002F\u002Fimg.shields.io\u002Ftravis\u002Forg\u002Frepo.svg)](https:\u002F\u002Ftravis-ci.org\u002Forg\u002Frepo)\n[![Coverage](https:\u002F\u002Fimg.shields.io\u002Fcodecov\u002Fc\u002Fgithub\u002Forg\u002Frepo.svg)](https:\u002F\u002Fcodecov.io\u002Fgh\u002Forg\u002Frepo)\n[![License](https:\u002F\u002Fimg.shields.io\u002Fbadge\u002Flicense-MIT-blue.svg)](LICENSE)\n\n> Production-ready REST API for e-commerce platform with advanced pricing, inventory management, and order processing.\n\n## Features\n\n- ✅ Dynamic pricing with customer tiers and volume discounts\n- ✅ Real-time inventory tracking\n- ✅ Order processing and fulfillment\n- ✅ JWT authentication with role-based access\n- ✅ Rate limiting and security middleware\n- ✅ Comprehensive API documentation (OpenAPI 3.0)\n\n## Quick Start\n\n### Prerequisites\n\n- Node.js >= 18.0.0\n- PostgreSQL >= 14.0\n- Redis >= 7.0 (for caching)\n\n### Installation\n\n```bash\n# Clone repository\ngit clone https:\u002F\u002Fgithub.com\u002Forg\u002Fecommerce-api.git\ncd ecommerce-api\n\n# Install dependencies\nnpm install\n\n# Configure environment\ncp .env.example .env\n# Edit .env with your database credentials\n\n# Run migrations\nnpm run migrate\n\n# Start server\nnpm start\n```\n\n### Usage\n\n```javascript\n\u002F\u002F Example: Calculate price with discounts\nconst response = await fetch(\n  'http:\u002F\u002Flocalhost:3000\u002Fapi\u002Fv1\u002Fproducts\u002Fprod-123\u002Fprice?quantity=60&customerType=premium'\n);\nconst { discountedPrice } = await response.json();\nconsole.log(`Final price: $${discountedPrice}`);\n```\n\n## API Documentation\n\nFull API documentation available at:\n- **Interactive Docs**: http:\u002F\u002Flocalhost:3000\u002Fapi-docs (Swagger UI)\n- **OpenAPI Spec**: [docs\u002FAPI.md](docs\u002FAPI.md)\n\n### Key Endpoints\n\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | `\u002Fapi\u002Fv1\u002Fproducts` | List all products |\n| GET | `\u002Fapi\u002Fv1\u002Fproducts\u002F{id}` | Get product details |\n| GET | `\u002Fapi\u002Fv1\u002Fproducts\u002F{id}\u002Fprice` | Calculate price with discounts |\n| POST | `\u002Fapi\u002Fv1\u002Forders` | Create new order |\n| GET | `\u002Fapi\u002Fv1\u002Forders\u002F{id}` | Get order status |\n\n## Architecture\n\n![System Architecture](docs\u002Fdiagrams\u002Fsystem-overview.svg)\n\nSee [ARCHITECTURE.md](docs\u002FARCHITECTURE.md) for detailed system design.\n\n## Configuration\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `PORT` | Server port | 3000 |\n| `DATABASE_URL` | PostgreSQL connection | - |\n| `REDIS_URL` | Redis connection | - |\n| `JWT_SECRET` | Authentication secret | - |\n\n## Testing\n\n```bash\n# Run all tests\nnpm test\n\n# Run with coverage\nnpm run test:coverage\n\n# Run integration tests\nnpm run test:integration\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.\n\n## License\n\nMIT © 2025 Your Organization\n```\n\n### Phase 5: COMPLETION - Integrate and Maintain Documentation\n\n**Objective**: Ensure documentation stays synchronized with code\n\n**Actions**:\n1. Integrate documentation into build pipeline\n2. Set up automated documentation updates\n3. Configure pre-commit hooks for comment validation\n4. Establish documentation review process\n5. Create documentation maintenance schedule\n\n**Deliverables**:\n- CI\u002FCD integration\n- Git hooks for documentation\n- Maintenance schedule\n- Documentation metrics dashboard\n\n**Integration Strategy**:\n```yaml\n# .github\u002Fworkflows\u002Fdocs.yml\nname: Documentation\n\non:\n  push:\n    branches: [main, develop]\n  pull_request:\n\njobs:\n  generate-docs:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions\u002Fcheckout@v3\n\n      - name: Setup Node.js\n        uses: actions\u002Fsetup-node@v3\n        with:\n          node-version: '18'\n\n      - name: Install dependencies\n        run: npm ci\n\n      - name: Generate API documentation\n        run: npm run docs:api\n\n      - name: Generate diagrams\n        run: npm run docs:diagrams\n\n      - name: Validate documentation\n        run: npm run docs:validate\n\n      - name: Check comment coverage\n        run: npm run docs:coverage\n\n      - name: Deploy to GitHub Pages\n        if: github.ref == 'refs\u002Fheads\u002Fmain'\n        uses: peaceiris\u002Factions-gh-pages@v3\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          publish_dir: .\u002Fdocs\n```\n\n**Pre-commit Hook**:\n```bash\n#!\u002Fbin\u002Fbash\n# .git\u002Fhooks\u002Fpre-commit\n\necho \"Checking documentation coverage...\"\n\n# Check for undocumented functions\nundocumented=$(npm run --silent docs:check-coverage)\n\nif [ $? -ne 0 ]; then\n  echo \"❌ Documentation coverage below threshold\"\n  echo \"$undocumented\"\n  echo \"\"\n  echo \"Please add documentation to new functions before committing.\"\n  exit 1\nfi\n\necho \"✅ Documentation coverage acceptable\"\n```\n\n## Usage Patterns\n\n### Basic Documentation Generation\n\n```bash\n# Generate all documentation\n\u002Fdoc-generate\n\n# Generate specific documentation type\n\u002Fdoc-api          # API documentation only\n\u002Fdoc-readme       # README generation only\n\u002Fdoc-inline       # Add inline comments only\n\u002Fdoc-diagrams     # Generate diagrams only\n```\n\n### Advanced Usage\n\n```bash\n# Generate with specific output format\nnpx claude-flow docs generate --format openapi --output docs\u002Fapi.yml\n\n# Generate for specific files\nnpx claude-flow docs generate --files \"src\u002F**\u002F*.js\" --type jsdoc\n\n# Generate with custom templates\nnpx claude-flow docs generate --template custom-readme.hbs\n\n# Update existing documentation\nnpx claude-flow docs update --incremental\n\n# Validate documentation completeness\nnpx claude-flow docs validate --min-coverage 80\n```\n\n## Documentation Standards\n\n### Comment Style Guide\n\n**JavaScript\u002FTypeScript (JSDoc)**:\n```javascript\n\u002F**\n * Brief description (one sentence, under 100 chars)\n *\n * Detailed description explaining the purpose, behavior, and any\n * important considerations. This can span multiple lines.\n *\n * @param {Type} paramName - Description of parameter\n * @param {Type} [optionalParam=defaultValue] - Optional parameter\n * @returns {Type} Description of return value\n * @throws {ErrorType} When error occurs\n *\n * @example\n * \u002F\u002F Example usage\n * const result = functionName(arg1, arg2);\n *\n * @see {@link RelatedFunction}\n * @since 1.0.0\n * @deprecated Use newFunction instead\n *\u002F\n```\n\n**Python (Google Style)**:\n```python\ndef function_name(param1: str, param2: int = 0) -> bool:\n    \"\"\"Brief description (one sentence).\n\n    Detailed description explaining the purpose and behavior.\n    Can span multiple lines with proper formatting.\n\n    Args:\n        param1: Description of first parameter\n        param2: Description of optional parameter (default: 0)\n\n    Returns:\n        Description of return value\n\n    Raises:\n        ValueError: When invalid input provided\n        RuntimeError: When operation fails\n\n    Example:\n        >>> result = function_name(\"test\", 5)\n        >>> print(result)\n        True\n\n    Note:\n        Important information or limitations\n    \"\"\"\n```\n\n### README Template Structure\n\n```markdown\n# Project Title\n\n> Brief description (one sentence tagline)\n\n[Badges: Build, Coverage, License, Version]\n\n## Features\n\n- Key feature 1\n- Key feature 2\n- Key feature 3\n\n## Quick Start\n\n### Prerequisites\n### Installation\n### Basic Usage\n\n## Documentation\n\n- [API Reference](docs\u002FAPI.md)\n- [Architecture](docs\u002FARCHITECTURE.md)\n- [Contributing](CONTRIBUTING.md)\n- [Changelog](CHANGELOG.md)\n\n## Examples\n\n### Basic Example\n### Advanced Example\n\n## Configuration\n\n## Testing\n\n## Deployment\n\n## Support\n\n## License\n```\n\n## Quality Metrics\n\n**Documentation Coverage Goals**:\n- Public API functions: 100% documented\n- Internal functions: 80% documented\n- Complex algorithms: 100% with inline comments\n- Type definitions: 100% documented\n- Examples: At least 1 per major feature\n\n**Validation Checks**:\n- ✅ All public functions have JSDoc\u002Fdocstrings\n- ✅ All parameters documented with types\n- ✅ Return values documented\n- ✅ Examples provided for complex functions\n- ✅ Links valid and accessible\n- ✅ No spelling errors\n- ✅ Consistent formatting\n\n## Troubleshooting\n\n### Common Issues\n\n**Issue**: Generated docs missing some functions\n- **Solution**: Check function export syntax, ensure `export` keyword used\n\n**Issue**: Diagrams not rendering\n- **Solution**: Install Graphviz: `brew install graphviz` or `apt install graphviz`\n\n**Issue**: JSDoc comments not showing in IDE\n- **Solution**: Configure TypeScript to include JSDoc in `tsconfig.json`\n\n**Issue**: README badges not updating\n- **Solution**: Check CI\u002FCD pipeline, verify badge URLs\n\n## Best Practices\n\n1. **Write documentation as you code** - Don't defer to later\n2. **Keep comments concise** - Explain \"why\" not \"what\"\n3. **Use examples liberally** - Show, don't just tell\n4. **Update diagrams regularly** - Keep architecture docs current\n5. **Validate before committing** - Use pre-commit hooks\n6. **Review documentation in PRs** - Treat docs as first-class code\n7. **Version documentation** - Tag docs with release versions\n8. **Link related concepts** - Create documentation graph\n9. **Avoid redundancy** - Single source of truth\n10. **Test examples** - Ensure code samples actually work\n\n## Integration with Other Skills\n\n- **code-review-assistant**: Validates documentation in PRs\n- **tdd-workflow**: Generates test documentation\n- **api-design-first**: Creates API docs from specs\n- **refactoring-assistant**: Updates docs during refactoring\n\n## References\n\n- [JSDoc Documentation](https:\u002F\u002Fjsdoc.app\u002F)\n- [TypeDoc Documentation](https:\u002F\u002Ftypedoc.org\u002F)\n- [OpenAPI Specification](https:\u002F\u002Fswagger.io\u002Fspecification\u002F)\n- [Google Python Style Guide](https:\u002F\u002Fgoogle.github.io\u002Fstyleguide\u002Fpyguide.html)\n- [Markdown Guide](https:\u002F\u002Fwww.markdownguide.org\u002F)\n- [Graphviz Documentation](https:\u002F\u002Fgraphviz.org\u002Fdocumentation\u002F)\n\n---\n\n**Version**: 1.0.0\n**Last Updated**: 2025-10-30\n**Maintainer**: Base Template Generator\n**Status**: Production Ready\n","# When Documenting Code - Use Doc Generator\n\n## Overview\n\nThis 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.\n\n## Core Capabilities\n\n1. **Code Analysis**: Extract APIs, functions, classes, types, and dependencies\n2. **API Documentation**: Generate OpenAPI, JSDoc, TypeDoc, and Python docstrings\n3. **README Generation**: Create comprehensive project documentation\n4. **Inline Comments**: Add missing documentation with context-aware comments\n5. **Diagram Generation**: Produce architecture and flow diagrams (Graphviz, Mermaid)\n\n## SPARC Methodology: Documentation Generation\n\n### Phase 1: SPECIFICATION - Analyze Documentation Requirements\n\n**Objective**: Understand the codebase structure and documentation needs\n\n**Actions**:\n1. Scan project structure and identify file types\n2. Detect programming languages and frameworks\n3. Identify existing documentation (README, API docs, comments)\n4. Analyze documentation gaps and missing coverage\n5. Determine documentation standards (JSDoc, TSDoc, Python docstrings)\n\n**Deliverables**:\n- Project structure analysis\n- Documentation gap report\n- Recommended documentation strategy\n- Style guide selection\n\n**Agent**: `code-analyzer`\n\n**Example Analysis**:\n```\nProject: express-api-server\nLanguages: JavaScript (TypeScript), 85% | JSON 10% | Markdown 5%\nFrameworks: Express.js, Jest\nCurrent Documentation:\n  - README.md: Exists (outdated, 3 months old)\n  - API Docs: None\n  - Inline Comments: 12% coverage\n  - Type Definitions: 45% coverage\n\nGaps Identified:\n  - ❌ No API documentation (12 endpoints undocumented)\n  - ❌ Missing installation instructions\n  - ❌ No architecture diagrams\n  - ⚠️  Low inline comment coverage\n  - ✅ Package.json well-documented\n\nRecommended Strategy:\n  1. Generate OpenAPI 3.0 spec for REST API\n  2. Add JSDoc comments to all public functions\n  3. Create comprehensive README with badges\n  4. Generate architecture diagram (system overview)\n  5. Add usage examples for main features\n```\n\n### Phase 2: PSEUDOCODE - Design Documentation Structure\n\n**Objective**: Plan documentation hierarchy and templates\n\n**Actions**:\n1. Design documentation structure (README, API, guides)\n2. Define comment style and conventions\n3. Create templates for each documentation type\n4. Plan diagram types and structure\n5. Define metadata and frontmatter standards\n\n**Deliverables**:\n- Documentation structure outline\n- Template designs for each type\n- Comment convention guide\n- Diagram specifications\n\n**Example Structure**:\n```\nDocumentation Hierarchy:\n\ndocs\u002F\n├── README.md                 # Project overview\n├── INSTALLATION.md          # Setup guide\n├── API.md                   # API reference\n├── ARCHITECTURE.md          # System design\n├── CONTRIBUTING.md          # Contribution guide\n├── diagrams\u002F\n│   ├── system-overview.svg  # High-level architecture\n│   ├── data-flow.svg        # Data flow diagram\n│   └── api-endpoints.svg    # API structure\n└── examples\u002F\n    ├── basic-usage.md\n    └── advanced-features.md\n\nComment Standards:\n- JSDoc for all exported functions\n- TypeDoc for TypeScript interfaces\n- File header with purpose and author\n- Inline comments for complex logic only\n\nAPI Documentation:\n- OpenAPI 3.0 specification\n- Example requests\u002Fresponses\n- Error code documentation\n- Authentication guide\n```\n\n### Phase 3: ARCHITECTURE - Define Generation Pipeline\n\n**Objective**: Design the documentation generation workflow\n\n**Actions**:\n1. Define code parsing strategy (AST, regex, static analysis)\n2. Design template engine for documentation generation\n3. Plan diagram generation pipeline (Graphviz\u002FMermaid)\n4. Define validation and quality checks\n5. Create update and versioning strategy\n\n**Deliverables**:\n- Documentation generation pipeline\n- Parser and extractor design\n- Template rendering engine\n- Validation rules\n\n**Pipeline Architecture**:\n```\n┌─────────────────┐\n│  Source Code    │\n│  Repository     │\n└────────┬────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Code Analyzer          │\n│  - AST Parsing          │\n│  - Extract Functions    │\n│  - Extract Types        │\n│  - Detect Patterns      │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Documentation Engine   │\n│  ├─ API Generator       │\n│  ├─ README Generator    │\n│  ├─ Comment Generator   │\n│  └─ Diagram Generator   │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Template Renderer      │\n│  - Mustache\u002FHandlebars  │\n│  - Markdown Formatting  │\n│  - Syntax Highlighting  │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Validator              │\n│  - Link Checking        │\n│  - Spelling             │\n│  - Completeness         │\n└────────┬────────────────┘\n         │\n         ▼\n┌─────────────────────────┐\n│  Output                 │\n│  - docs\u002F                │\n│  - Inline Comments      │\n│  - Generated Diagrams   │\n└─────────────────────────┘\n```\n\n### Phase 4: REFINEMENT - Generate and Validate Documentation\n\n**Objective**: Execute documentation generation with quality checks\n\n**Actions**:\n1. Parse source code and extract documentation targets\n2. Generate API documentation from code signatures\n3. Create README from templates and project metadata\n4. Add inline comments to undocumented code\n5. Generate architecture and flow diagrams\n6. Validate completeness and accuracy\n7. Check links and references\n8. Format and style according to standards\n\n**Deliverables**:\n- Complete API documentation\n- Comprehensive README\n- Inline code comments\n- Architecture diagrams\n- Validation report\n\n**Generation Examples**:\n\n**Before (Undocumented Function)**:\n```javascript\nfunction calculateDiscount(price, customerType, quantity) {\n  const baseDiscount = customerType === 'premium' ? 0.15 : 0.05;\n  const volumeDiscount = quantity > 100 ? 0.1 : quantity > 50 ? 0.05 : 0;\n  return price * (1 - baseDiscount - volumeDiscount);\n}\n```\n\n**After (With JSDoc)**:\n```javascript\n\u002F**\n * Calculates the final price after applying customer and volume discounts\n *\n * @param {number} price - The original price before discounts\n * @param {('standard'|'premium')} customerType - Customer tier level\n * @param {number} quantity - Number of items purchased\n * @returns {number} The discounted price\n *\n * @example\n * \u002F\u002F Premium customer buying 60 items at $100 each\n * calculateDiscount(100, 'premium', 60);\n * \u002F\u002F Returns: 80 (15% customer + 5% volume discount)\n *\n * @see {@link https:\u002F\u002Fdocs.example.com\u002Fpricing|Pricing Documentation}\n *\u002F\nfunction calculateDiscount(price, customerType, quantity) {\n  \u002F\u002F Premium customers receive 15% base discount, standard customers 5%\n  const baseDiscount = customerType === 'premium' ? 0.15 : 0.05;\n\n  \u002F\u002F Volume discounts: 10% for 100+, 5% for 50+, 0% otherwise\n  const volumeDiscount = quantity > 100 ? 0.1 : quantity > 50 ? 0.05 : 0;\n\n  return price * (1 - baseDiscount - volumeDiscount);\n}\n```\n\n**API Documentation Generation**:\n```yaml\n# Generated OpenAPI 3.0 Specification\nopenapi: 3.0.0\ninfo:\n  title: E-commerce API\n  version: 1.0.0\n  description: REST API for e-commerce platform with pricing and inventory\n\npaths:\n  \u002Fapi\u002Fv1\u002Fproducts\u002F{id}\u002Fprice:\n    get:\n      summary: Calculate product price with discounts\n      description: Returns the final price after applying customer tier and volume discounts\n      operationId: calculateProductPrice\n      tags:\n        - Pricing\n      parameters:\n        - name: id\n          in: path\n          required: true\n          schema:\n            type: string\n          description: Product ID\n        - name: quantity\n          in: query\n          required: true\n          schema:\n            type: integer\n            minimum: 1\n          description: Quantity to purchase\n        - name: customerType\n          in: query\n          required: false\n          schema:\n            type: string\n            enum: [standard, premium]\n            default: standard\n          description: Customer tier level\n      responses:\n        '200':\n          description: Price calculated successfully\n          content:\n            application\u002Fjson:\n              schema:\n                type: object\n                properties:\n                  originalPrice:\n                    type: number\n                    example: 100.00\n                  discountedPrice:\n                    type: number\n                    example: 80.00\n                  discountsApplied:\n                    type: array\n                    items:\n                      type: object\n                      properties:\n                        type:\n                          type: string\n                          enum: [customer, volume]\n                        percentage:\n                          type: number\n                          example: 0.15\n        '404':\n          description: Product not found\n```\n\n**README Generation**:\n```markdown\n# E-commerce API Server\n\n[![Build Status](https:\u002F\u002Fimg.shields.io\u002Ftravis\u002Forg\u002Frepo.svg)](https:\u002F\u002Ftravis-ci.org\u002Forg\u002Frepo)\n[![Coverage](https:\u002F\u002Fimg.shields.io\u002Fcodecov\u002Fc\u002Fgithub\u002Forg\u002Frepo.svg)](https:\u002F\u002Fcodecov.io\u002Fgh\u002Forg\u002Frepo)\n[![License](https:\u002F\u002Fimg.shields.io\u002Fbadge\u002Flicense-MIT-blue.svg)](LICENSE)\n\n> Production-ready REST API for e-commerce platform with advanced pricing, inventory management, and order processing.\n\n## Features\n\n- ✅ Dynamic pricing with customer tiers and volume discounts\n- ✅ Real-time inventory tracking\n- ✅ Order processing and fulfillment\n- ✅ JWT authentication with role-based access\n- ✅ Rate limiting and security middleware\n- ✅ Comprehensive API documentation (OpenAPI 3.0)\n\n## Quick Start\n\n### Prerequisites\n\n- Node.js >= 18.0.0\n- PostgreSQL >= 14.0\n- Redis >= 7.0 (for caching)\n\n### Installation\n\n```bash\n# Clone repository\ngit clone https:\u002F\u002Fgithub.com\u002Forg\u002Fecommerce-api.git\ncd ecommerce-api\n\n# Install dependencies\nnpm install\n\n# Configure environment\ncp .env.example .env\n# Edit .env with your database credentials\n\n# Run migrations\nnpm run migrate\n\n# Start server\nnpm start\n```\n\n### Usage\n\n```javascript\n\u002F\u002F Example: Calculate price with discounts\nconst response = await fetch(\n  'http:\u002F\u002Flocalhost:3000\u002Fapi\u002Fv1\u002Fproducts\u002Fprod-123\u002Fprice?quantity=60&customerType=premium'\n);\nconst { discountedPrice } = await response.json();\nconsole.log(`Final price: $${discountedPrice}`);\n```\n\n## API Documentation\n\nFull API documentation available at:\n- **Interactive Docs**: http:\u002F\u002Flocalhost:3000\u002Fapi-docs (Swagger UI)\n- **OpenAPI Spec**: [docs\u002FAPI.md](docs\u002FAPI.md)\n\n### Key Endpoints\n\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | `\u002Fapi\u002Fv1\u002Fproducts` | List all products |\n| GET | `\u002Fapi\u002Fv1\u002Fproducts\u002F{id}` | Get product details |\n| GET | `\u002Fapi\u002Fv1\u002Fproducts\u002F{id}\u002Fprice` | Calculate price with discounts |\n| POST | `\u002Fapi\u002Fv1\u002Forders` | Create new order |\n| GET | `\u002Fapi\u002Fv1\u002Forders\u002F{id}` | Get order status |\n\n## Architecture\n\n![System Architecture](docs\u002Fdiagrams\u002Fsystem-overview.svg)\n\nSee [ARCHITECTURE.md](docs\u002FARCHITECTURE.md) for detailed system design.\n\n## Configuration\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `PORT` | Server port | 3000 |\n| `DATABASE_URL` | PostgreSQL connection | - |\n| `REDIS_URL` | Redis connection | - |\n| `JWT_SECRET` | Authentication secret | - |\n\n## Testing\n\n```bash\n# Run all tests\nnpm test\n\n# Run with coverage\nnpm run test:coverage\n\n# Run integration tests\nnpm run test:integration\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.\n\n## License\n\nMIT © 2025 Your Organization\n```\n\n### Phase 5: COMPLETION - Integrate and Maintain Documentation\n\n**Objective**: Ensure documentation stays synchronized with code\n\n**Actions**:\n1. Integrate documentation into build pipeline\n2. Set up automated documentation updates\n3. Configure pre-commit hooks for comment validation\n4. Establish documentation review process\n5. Create documentation maintenance schedule\n\n**Deliverables**:\n- CI\u002FCD integration\n- Git hooks for documentation\n- Maintenance schedule\n- Documentation metrics dashboard\n\n**Integration Strategy**:\n```yaml\n# .github\u002Fworkflows\u002Fdocs.yml\nname: Documentation\n\non:\n  push:\n    branches: [main, develop]\n  pull_request:\n\njobs:\n  generate-docs:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions\u002Fcheckout@v3\n\n      - name: Setup Node.js\n        uses: actions\u002Fsetup-node@v3\n        with:\n          node-version: '18'\n\n      - name: Install dependencies\n        run: npm ci\n\n      - name: Generate API documentation\n        run: npm run docs:api\n\n      - name: Generate diagrams\n        run: npm run docs:diagrams\n\n      - name: Validate documentation\n        run: npm run docs:validate\n\n      - name: Check comment coverage\n        run: npm run docs:coverage\n\n      - name: Deploy to GitHub Pages\n        if: github.ref == 'refs\u002Fheads\u002Fmain'\n        uses: peaceiris\u002Factions-gh-pages@v3\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          publish_dir: .\u002Fdocs\n```\n\n**Pre-commit Hook**:\n```bash\n#!\u002Fbin\u002Fbash\n# .git\u002Fhooks\u002Fpre-commit\n\necho \"Checking documentation coverage...\"\n\n# Check for undocumented functions\nundocumented=$(npm run --silent docs:check-coverage)\n\nif [ $? -ne 0 ]; then\n  echo \"❌ Documentation coverage below threshold\"\n  echo \"$undocumented\"\n  echo \"\"\n  echo \"Please add documentation to new functions before committing.\"\n  exit 1\nfi\n\necho \"✅ Documentation coverage acceptable\"\n```\n\n## Usage Patterns\n\n### Basic Documentation Generation\n\n```bash\n# Generate all documentation\n\u002Fdoc-generate\n\n# Generate specific documentation type\n\u002Fdoc-api          # API documentation only\n\u002Fdoc-readme       # README generation only\n\u002Fdoc-inline       # Add inline comments only\n\u002Fdoc-diagrams     # Generate diagrams only\n```\n\n### Advanced Usage\n\n```bash\n# Generate with specific output format\nnpx claude-flow docs generate --format openapi --output docs\u002Fapi.yml\n\n# Generate for specific files\nnpx claude-flow docs generate --files \"src\u002F**\u002F*.js\" --type jsdoc\n\n# Generate with custom templates\nnpx claude-flow docs generate --template custom-readme.hbs\n\n# Update existing documentation\nnpx claude-flow docs update --incremental\n\n# Validate documentation completeness\nnpx claude-flow docs validate --min-coverage 80\n```\n\n## Documentation Standards\n\n### Comment Style Guide\n\n**JavaScript\u002FTypeScript (JSDoc)**:\n```javascript\n\u002F**\n * Brief description (one sentence, under 100 chars)\n *\n * Detailed description explaining the purpose, behavior, and any\n * important considerations. This can span multiple lines.\n *\n * @param {Type} paramName - Description of parameter\n * @param {Type} [optionalParam=defaultValue] - Optional parameter\n * @returns {Type} Description of return value\n * @throws {ErrorType} When error occurs\n *\n * @example\n * \u002F\u002F Example usage\n * const result = functionName(arg1, arg2);\n *\n * @see {@link RelatedFunction}\n * @since 1.0.0\n * @deprecated Use newFunction instead\n *\u002F\n```\n\n**Python (Google Style)**:\n```python\ndef function_name(param1: str, param2: int = 0) -> bool:\n    \"\"\"Brief description (one sentence).\n\n    Detailed description explaining the purpose and behavior.\n    Can span multiple lines with proper formatting.\n\n    Args:\n        param1: Description of first parameter\n        param2: Description of optional parameter (default: 0)\n\n    Returns:\n        Description of return value\n\n    Raises:\n        ValueError: When invalid input provided\n        RuntimeError: When operation fails\n\n    Example:\n        >>> result = function_name(\"test\", 5)\n        >>> print(result)\n        True\n\n    Note:\n        Important information or limitations\n    \"\"\"\n```\n\n### README Template Structure\n\n```markdown\n# Project Title\n\n> Brief description (one sentence tagline)\n\n[Badges: Build, Coverage, License, Version]\n\n## Features\n\n- Key feature 1\n- Key feature 2\n- Key feature 3\n\n## Quick Start\n\n### Prerequisites\n### Installation\n### Basic Usage\n\n## Documentation\n\n- [API Reference](docs\u002FAPI.md)\n- [Architecture](docs\u002FARCHITECTURE.md)\n- [Contributing](CONTRIBUTING.md)\n- [Changelog](CHANGELOG.md)\n\n## Examples\n\n### Basic Example\n### Advanced Example\n\n## Configuration\n\n## Testing\n\n## Deployment\n\n## Support\n\n## License\n```\n\n## Quality Metrics\n\n**Documentation Coverage Goals**:\n- Public API functions: 100% documented\n- Internal functions: 80% documented\n- Complex algorithms: 100% with inline comments\n- Type definitions: 100% documented\n- Examples: At least 1 per major feature\n\n**Validation Checks**:\n- ✅ All public functions have JSDoc\u002Fdocstrings\n- ✅ All parameters documented with types\n- ✅ Return values documented\n- ✅ Examples provided for complex functions\n- ✅ Links valid and accessible\n- ✅ No spelling errors\n- ✅ Consistent formatting\n\n## Troubleshooting\n\n### Common Issues\n\n**Issue**: Generated docs missing some functions\n- **Solution**: Check function export syntax, ensure `export` keyword used\n\n**Issue**: Diagrams not rendering\n- **Solution**: Install Graphviz: `brew install graphviz` or `apt install graphviz`\n\n**Issue**: JSDoc comments not showing in IDE\n- **Solution**: Configure TypeScript to include JSDoc in `tsconfig.json`\n\n**Issue**: README badges not updating\n- **Solution**: Check CI\u002FCD pipeline, verify badge URLs\n\n## Best Practices\n\n1. **Write documentation as you code** - Don't defer to later\n2. **Keep comments concise** - Explain \"why\" not \"what\"\n3. **Use examples liberally** - Show, don't just tell\n4. **Update diagrams regularly** - Keep architecture docs current\n5. **Validate before committing** - Use pre-commit hooks\n6. **Review documentation in PRs** - Treat docs as first-class code\n7. **Version documentation** - Tag docs with release versions\n8. **Link related concepts** - Create documentation graph\n9. **Avoid redundancy** - Single source of truth\n10. **Test examples** - Ensure code samples actually work\n\n## Integration with Other Skills\n\n- **code-review-assistant**: Validates documentation in PRs\n- **tdd-workflow**: Generates test documentation\n- **api-design-first**: Creates API docs from specs\n- **refactoring-assistant**: Updates docs during refactoring\n\n## References\n\n- [JSDoc Documentation](https:\u002F\u002Fjsdoc.app\u002F)\n- [TypeDoc Documentation](https:\u002F\u002Ftypedoc.org\u002F)\n- [OpenAPI Specification](https:\u002F\u002Fswagger.io\u002Fspecification\u002F)\n- [Google Python Style Guide](https:\u002F\u002Fgoogle.github.io\u002Fstyleguide\u002Fpyguide.html)\n- [Markdown Guide](https:\u002F\u002Fwww.markdownguide.org\u002F)\n- [Graphviz Documentation](https:\u002F\u002Fgraphviz.org\u002Fdocumentation\u002F)\n\n---\n\n**Version**: 1.0.0\n**Last Updated**: 2025-10-30\n**Maintainer**: Base Template Generator\n**Status**: Production Ready\n",{"name":5,"tags":57,"agents":61,"version":64,"triggers":65,"complexity":70,"description":7},[51,38,58,59,43,60],"readme","comments","automation",[62,63],"code-analyzer","base-template-generator","1.0.0",[40,66,67,68,69],"create API docs","write README","add comments","document this code","medium","main","def8531e65114c0fca8fb8551c1871ee0eed705c","skills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator",24,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub","https:\u002F\u002Fskillshub.wtf","https:\u002F\u002Fgithub.com\u002FComeOnOliver","AI & Blockchain Engineer\r\n","2026-06-24 22:07:19",{"source":8,"skillName":5,"commands":81,"prompt":91,"zipAvailable":92},[82,85,88],{"tool":83,"command":84},"npx","npx skills add ComeOnOliver\u002Fskillshub --skill when-documenting-code-use-doc-generator",{"tool":86,"command":87},"bunx","bunx skills add ComeOnOliver\u002Fskillshub --skill when-documenting-code-use-doc-generator",{"tool":89,"command":90},"pnpm","pnpm dlx skills add ComeOnOliver\u002Fskillshub --skill when-documenting-code-use-doc-generator","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002FSKILL.md",true,[94,100,106,110,114,120,124,128],{"path":95,"resourceType":96,"resourceTypeDesc":97,"sizeBytes":98,"sourceHtmlUrl":99},"process-diagram.gv","OTHER","其他",4987,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002Fprocess-diagram.gv",{"path":101,"resourceType":102,"resourceTypeDesc":103,"sizeBytes":104,"sourceHtmlUrl":105},"PROCESS.md","REFERENCE","参考文档",20130,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002FPROCESS.md",{"path":107,"resourceType":102,"resourceTypeDesc":103,"sizeBytes":108,"sourceHtmlUrl":109},"README.md",8376,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002FREADME.md",{"path":111,"resourceType":102,"resourceTypeDesc":103,"sizeBytes":112,"sourceHtmlUrl":113},"skill-report.json",11171,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002Fskill-report.json",{"path":115,"resourceType":116,"resourceTypeDesc":117,"sizeBytes":118,"sourceHtmlUrl":119},"slash-command-doc-api.sh","SCRIPT","脚本",11313,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002Fslash-command-doc-api.sh",{"path":121,"resourceType":116,"resourceTypeDesc":117,"sizeBytes":122,"sourceHtmlUrl":123},"slash-command-doc-inline.sh",11674,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002Fslash-command-doc-inline.sh",{"path":125,"resourceType":116,"resourceTypeDesc":117,"sizeBytes":126,"sourceHtmlUrl":127},"slash-command-doc-readme.sh",12952,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002Fslash-command-doc-readme.sh",{"path":129,"resourceType":102,"resourceTypeDesc":103,"sizeBytes":130,"sourceHtmlUrl":131},"subagent-doc-generator.md",12211,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fdnyoussef\u002Fwhen-documenting-code-use-doc-generator\u002Fsubagent-doc-generator.md",[133,143,153,162,168,175],{"skillNo":134,"name":135,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":136,"categories":137,"keywords":139,"publishedAt":52},"01M6FKJN13GMG4KY57J3QD8GY5","model-hierarchy-skill","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzscole\u002Fmodel-hierarchy-skill\u002Fmodel-hierarchy-skill\u002FSKILL.md",[138],{"categoryNo":24,"categoryName":25,"taxonomyType":21,"taxonomyTypeDesc":22},[140,141,142],"model","model hierarchy","model hierarchy skill",{"skillNo":144,"name":145,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":146,"categories":147,"keywords":149,"publishedAt":52},"01M6FKJJJ6GCAMR4PPPRD12M5X","zoom-mcp","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fzoom-mcp\u002FSKILL.md",[148],{"categoryNo":24,"categoryName":25,"taxonomyType":21,"taxonomyTypeDesc":22},[150,151,152],"MCP","zoom","zoom mcp",{"skillNo":154,"name":155,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":156,"categories":157,"keywords":158,"publishedAt":52},"01M6FKJE3KYT3KPEZMEEHYKA6K","zoom-apps-sdk","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fzoom-apps-sdk\u002FSKILL.md",[],[159,160,161,151],"sdk","zoom apps sdk","apps",{"skillNo":163,"name":164,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":165,"categories":166,"keywords":167,"publishedAt":52},"01M6FKJ9EDH9Q5VWDF8HAJRSP0","windows","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fwindows\u002FSKILL.md",[],[164],{"skillNo":169,"name":170,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":171,"categories":172,"keywords":174,"publishedAt":52},"01M6FKJ666BEEFC3AE9GJ72Q93","whiteboard","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fwhiteboard\u002FSKILL.md",[173],{"categoryNo":24,"categoryName":25,"taxonomyType":21,"taxonomyTypeDesc":22},[170],{"skillNo":176,"name":177,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":178,"categories":179,"keywords":180,"publishedAt":52},"01M6FKJ21WFCDGTJQ2Q91T9DVW","websockets","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fwebsockets\u002FSKILL.md",[],[177]]