generating-documentation

SKILL.md

Generate comprehensive technical documentation across multiple layers: API documentation, code documentation, documentation sites, architecture decisions, and system diagrams.

Layer 1: API Documentation - OpenAPI specs for REST/GraphQL APIs (Swagger UI, Redoc, Scalar) Layer 2: Code Documentation - Generated from code comments (TypeDoc, Sphinx, godoc, rustdoc) Layer 3: Documentation Sites - Comprehensive guides and tutorials (Docusaurus, MkDocs) Layer 4: Architecture Decisions - ADRs using MADR template format

See references/api-documentation.md, references/code-documentation.md, and references/documentation-sites.md for detailed guides.

Générez une documentation technique complète comprenant des documents API (OpenAPI/Swagger), de la documentation de code (TypeDoc/Sphinx), des sites de documentation (Docusaurus/MkDocs), des enregistrements de décisions d'architecture (ADR) et des diagrammes (Mermaid/PlantUML). À utiliser lors de la documentation des API, des bibliothèques, de l'architecture des systèmes ou de la création de sites de documentation destinés aux développeurs. Source : ancoleman/ai-design-components.

Voir l'original