documentation-generator

Solid

Generate documentation for migrated systems including API docs, architecture docs, and runbooks

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 95/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Generator Skill Generates comprehensive documentation for migrated systems including API documentation, architecture diagrams, and operational runbooks. ## Purpose Enable documentation creation for: - API documentation generation - Architecture documentation - Runbook generation - Change documentation - Diagram generation ## Capabilities ### 1. API Documentation Generation - Generate from OpenAPI specs - Create interactive docs - Include examples - Support versioning ### 2. Architecture Documentation - Create architecture diagrams - Document components - Map dependencies - Explain patterns ### 3. Runbook Generation - Create operational procedures - Document troubleshooting - Include escalation paths - Generate playbooks ### 4. Change Documentation - Document migration changes - Track before/after - Note breaking changes - Generate release notes ### 5. Migration Guide Creation - Create upgrade guides - Document migration steps - Include rollback procedures - Provide checklists ### 6. Diagram Generation - Generate architecture diagrams - Create sequence diagrams - Build data flow diagrams - Produce deployment diagrams ## Tool Integrations | Tool | Purpose | Integration Method | |------|---------|-------------------| | Swagger UI | API docs | CLI | | AsyncAPI | Event docs | CLI | | PlantUML | Diagrams | CLI | | Mermaid | Diagrams | Markdown | | Backstage | Developer portal | Config | | MkDocs | Documentation site | CLI | ## Output Schema ```json { ...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Related Skills