SuperAPI AI 工具集

api documentation skill

编程与开发

查看项目

更新于 10-15 21:40

技能介绍

用途:该技能聚焦技术文档编写,覆盖 API 参考、用户指南、README 以及 docs-as-code 工作流,适合需要为产品或 API 建立结构化文档的开发者与文档团队。

主要能力:提供文档项目脚手架,推荐 docs-project 目录结构,包含 docs/、examples/、assets/ 以及 mkdocs.yml 或 docusaurus.config.js 等配置文件;提供 DOCS-PLAN.md、API-ENDPOINT.md、copilot-instructions.md 等模板;给出文档项目审计清单,从结构、内容、质量等维度检查;整理 API 参考、用户指南、README 的章节结构;列举 MkDocs、Docusaurus、Sphinx、GitBook、VitePress 等静态站点生成器,以及 OpenAPI/Swagger、Redoc、Stoplight、Postman 等 API 文档工具;总结技术写作的 4C 原则(Clear、Concise、Correct、Complete)与代码示例准则。

使用方式:按推荐结构搭建文档目录,使用模板编写文档计划与端点说明,在 copilot-instructions.md 中定义受众、语气与风格规则,并借助审计清单逐项核对。资料未提供具体安装命令或运行步骤。

适用场景:为 API 编写参考文档、搭建 docs-as-code 项目、制定文档风格指南、审查现有文档质量。

限制:资料未说明收费、价格、平台支持范围或实际效果;部分工具与模板需结合具体项目调整,代码示例需自行测试验证。