SuperAPI AI 工具集

sdk-documentation-generator

写作与研究

查看项目

更新于 10-15 23:29

技能介绍

用途:该技能用于在技术文档领域中自动协助 SDK 文档生成器相关任务,当请求中提到“sdk documentation generator”、询问其模式或最佳实践,或需要 API 文档、用户指南、架构文档与文档自动化帮助时自动激活。

主要能力:提供分步指导;遵循行业最佳实践与模式;生成可直接用于生产的代码和配置;按通用标准校验输出。输出包含生成的配置与代码、最佳实践建议以及校验结果。

使用方式:在请求中提及 sdk documentation generator 即可触发。示例请求为“Help me with sdk documentation generator”,结果为提供分步指导并生成相应配置。

适用场景:技术文档编写与自动化,包括 API 文档、README、用户指南和架构文档等。标签涉及 documentation、markdown、api-docs、readme、technical-writing。

限制与前提:需要配置相关开发环境、可访问必要工具与服务,并具备技术文档概念的基本理解。错误处理方面,配置无效需检查必填字段,工具未找到需按前提安装依赖,权限被拒需核实凭据与权限。具体安装命令、价格与平台信息暂未提供。