documentation_generation.yaml•1.52 kB
name: "Documentation Generation"
description: "Generate comprehensive project documentation"
steps:
- id: code_analysis
agent: claude
task: "Analyze the codebase at {{ code_path }} and extract all public APIs, functions, and classes."
output: code_structure
description: "Extract code structure"
- id: generate_api_docs
agent: claude
task: "Generate API documentation for: {{ code_structure }}. Include parameters, return types, and examples."
output: api_documentation
condition: "{{ code_structure | length > 0 }}"
description: "Generate API docs"
- id: write_user_guide
agent: claude
task: "Write a user guide explaining how to use this code. API: {{ api_documentation }}"
output: user_guide
condition: "{{ api_documentation | length > 0 }}"
description: "Write user guide"
- id: create_examples
agent: gemini
task: "Create code examples demonstrating key features. Based on: {{ api_documentation }}"
output: code_examples
condition: "{{ user_guide | length > 0 }}"
description: "Create example code"
- id: generate_readme
agent: claude
task: "Generate a comprehensive README.md. Include: overview, installation, usage examples: {{ code_examples }}, and API reference."
output: readme
condition: "{{ code_examples | length > 0 }}"
description: "Generate README"
metadata:
category: documentation
difficulty: beginner
estimated_duration: 180
tags:
- documentation
- api-docs
- readme