generating-documentation

What problem does it solve?

This Skill automates the creation of various types of technical documentation, reducing manual effort and ensuring consistency across API documentation, code documentation, documentation sites, Architecture Decision Records (ADRs), and system diagrams.

Core Features & Use Cases

• API Documentation: Generate OpenAPI (Swagger) specifications for REST and GraphQL APIs.
• Code Documentation: Create documentation from code comments for TypeScript, Python, Go, and Rust.
• Documentation Sites: Build developer-facing sites using Docusaurus or MkDocs.
• Architecture Decision Records (ADRs): Document significant architectural decisions using the MADR template.
• Diagrams: Generate visual representations of system architecture using Mermaid, PlantUML, or D2.
• Use Case: A software team needs to document a new microservice. This Skill can generate the OpenAPI spec, TypeDoc for its TypeScript codebase, and a Mermaid diagram of its architecture, all integrated into their project's documentation site.

Quick Start

Use the generating-documentation skill to create an OpenAPI specification for a new REST API.