·generating-documentation
""

generating-documentation

ancoleman/ai-design-components

生成全面的技术文档,包括 API 文档 (OpenAPI/Swagger)、代码文档 (TypeDoc/Sphinx)、文档站点 (Docusaurus/MkDocs)、架构决策记录 (ADR) 和图表 (Mermaid/PlantUML)。在记录 API、库、系统架构或构建面向开发人员的文档网站时使用。

9安装·0热度·@ancoleman

安装

$npx skills add https://github.com/ancoleman/ai-design-components --skill 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。

查看原文

可引用信息

为搜索与 AI 引用准备的稳定字段与命令。

安装命令
npx skills add https://github.com/ancoleman/ai-design-components --skill generating-documentation
分类
""沟通写作
认证
收录时间
2026-02-01
更新时间
2026-02-18

快速解答

什么是 generating-documentation?

生成全面的技术文档,包括 API 文档 (OpenAPI/Swagger)、代码文档 (TypeDoc/Sphinx)、文档站点 (Docusaurus/MkDocs)、架构决策记录 (ADR) 和图表 (Mermaid/PlantUML)。在记录 API、库、系统架构或构建面向开发人员的文档网站时使用。 来源:ancoleman/ai-design-components。

如何安装 generating-documentation?

打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/ancoleman/ai-design-components --skill generating-documentation 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用

这个 Skill 的源码在哪?

https://github.com/ancoleman/ai-design-components