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.

API ドキュメント (OpenAPI/Swagger)、コード ドキュメント (TypeDoc/Sphinx)、ドキュメント サイト (Docusaurus/MkDocs)、アーキテクチャ決定記録 (ADR)、図 (Mermaid/PlantUML) などの包括的な技術ドキュメントを生成します。 API、ライブラリ、システム アーキテクチャを文書化する場合、または開発者向けのドキュメント サイトを構築する場合に使用します。 ソース: ancoleman/ai-design-components。

原文を見る