98 lines
2.1 KiB
YAML
98 lines
2.1 KiB
YAML
# Documentation Generator Skill
|
|
# Generates comprehensive dual-audience documentation
|
|
|
|
name: documentation-generator
|
|
version: "1.0.0"
|
|
description: |
|
|
Analyzes project structure and generates comprehensive documentation
|
|
that serves both technical (engineers) and non-technical audiences.
|
|
|
|
triggers:
|
|
commands:
|
|
- "/eureka:index"
|
|
- "/eureka:docs"
|
|
keywords:
|
|
- "generate documentation"
|
|
- "create docs"
|
|
- "document project"
|
|
- "project documentation"
|
|
- "index project"
|
|
|
|
agents:
|
|
- doc-writer
|
|
|
|
schemas:
|
|
- documentation_output.yml
|
|
- project_analysis.yml
|
|
|
|
scripts:
|
|
- analyze_project.py
|
|
- generate_html.py
|
|
|
|
templates:
|
|
- documentation.html
|
|
|
|
capabilities:
|
|
- Project structure analysis
|
|
- Dual-audience documentation generation
|
|
- ASCII diagram creation
|
|
- API documentation
|
|
- Component cataloging
|
|
- Glossary generation
|
|
|
|
outputs:
|
|
primary:
|
|
- index.html # Beautiful HTML for non-engineers
|
|
- PROJECT_DOCUMENTATION.md
|
|
- QUICK_REFERENCE.md
|
|
optional:
|
|
- API_REFERENCE.md
|
|
- COMPONENTS.md
|
|
- GLOSSARY.md
|
|
data:
|
|
- analysis.yml # Project analysis data
|
|
|
|
audience_support:
|
|
non_technical:
|
|
- Executive Summary
|
|
- Feature Guide
|
|
- Glossary
|
|
- Visual Diagrams
|
|
technical:
|
|
- API Reference
|
|
- Component Catalog
|
|
- Data Models
|
|
- Code Examples
|
|
|
|
configuration:
|
|
default_output_dir: docs
|
|
supported_formats:
|
|
- markdown
|
|
- html
|
|
default_sections:
|
|
- executive_summary
|
|
- architecture_overview
|
|
- getting_started
|
|
- features
|
|
- api_reference
|
|
- component_catalog
|
|
- data_models
|
|
- glossary
|
|
|
|
dependencies:
|
|
required:
|
|
- Read tool (file access)
|
|
- Write tool (file creation)
|
|
- Glob tool (file discovery)
|
|
- Grep tool (pattern search)
|
|
optional:
|
|
- Bash tool (script execution)
|
|
- Task tool (agent delegation)
|
|
|
|
quality_gates:
|
|
- All referenced files must exist
|
|
- All code examples must be syntactically valid
|
|
- All internal links must resolve
|
|
- Technical details wrapped in collapsible sections
|
|
- Glossary covers all technical terms used
|