Can I generate visual system diagrams?

Yes, the skill specializes in generating declarative syntax for Mermaid, PlantUML, and D2 to visualize system architecture and data flows.

Does it help with architectural planning?

Absolutely. It includes MADR templates for creating Architecture Decision Records (ADRs) to help teams track and justify technical design choices.

Which documentation tools does this skill support?

It supports a wide range of industry standards including Docusaurus, MkDocs, OpenAPI/Swagger, TypeDoc, Sphinx, godoc, rustdoc, and Mermaid diagrams.

Can I automate documentation generation with this skill?

Yes, it provides specific guidance and CI/CD templates for GitHub Actions to automate the building and deployment of documentation sites.

Is it suitable for both REST and GraphQL APIs?

Yes, it provides patterns for documenting both RESTful APIs via OpenAPI specs and GraphQL schemas for external consumers.

Technical Documentation Generator

Name: Technical Documentation Generator
Author: ancoleman

byancoleman

•

158

•

学习与文档

Generates comprehensive technical documentation including API specs, code docs, architecture decision records, and system diagrams.

This skill enables Claude to architect and generate professional documentation across five distinct layers: API specifications (OpenAPI/Swagger), code-level documentation (TypeDoc/Sphinx), full-scale documentation sites (Docusaurus/MkDocs), Architectural Decision Records (ADRs), and visual system diagrams (Mermaid/PlantUML). It is designed to implement a robust 'docs-as-code' workflow, ensuring that technical resources remain synchronized with codebases, automated via CI/CD, and highly accessible to both developers and stakeholders.

主要功能

01158 GitHub stars

02Standardized Architectural Decision Records (ADRs) using the MADR template

03Declarative visual system modeling with Mermaid, PlantUML, and D2

04Automated CI/CD integration patterns for GitHub Actions and documentation deployment

05Multi-layer documentation strategy covering API, Code, Site, ADR, and Diagrams

06Support for industry-standard tools including Docusaurus, MkDocs, and OpenAPI 3.1

使用场景

01Recording and tracking significant architectural trade-offs and decisions for long-term maintenance

02Building comprehensive developer portals and tutorials using Docusaurus or MkDocs

03Designing and documenting REST or GraphQL APIs with interactive Swagger or Redoc UI

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add ancoleman/ai-design-components generating-documentation

For use in Claude.ai and ChatGPT

Download Skill