SuperAPI AI 工具集

documentation-builder

写作与研究

查看项目

更新于 10-15 21:48

技能介绍

用途:帮助生成和整理各类技术文档,包括 API 文档、用户手册、开发指南、README 和项目文档。

主要能力:生成 RESTful API 文档,描述端点、参数与响应,提供请求响应示例,并可创建 Swagger/OpenAPI 交互式文档;编写用户使用指南、快速入门、FAQ 及操作步骤;编写开发环境搭建、代码贡献、架构设计与开发最佳实践;生成项目 README、安装使用说明、CHANGELOG 和项目结构说明。

使用方式:资料给出文档编写原则(清晰、完整、准确、实用、可维护)、建议结构(概述、快速开始、详细说明、API 参考、示例、常见问题)、可用格式(Markdown、reStructuredText、HTML、PDF)以及输出内容(文档文件、目录结构、代码示例、图表截图、链接引用)。使用流程分为环境准备、配置初始化、核心功能使用、测试验证、部署上线。

适用场景:需要为项目编写或补充文档、统一文档规范、快速上手对应技术栈时。

限制:复杂业务逻辑需结合具体场景调整,性能优化需按实际数据量评估;不适用于不相关技术栈或需要完全自定义的特殊场景。具体安装命令、配置参数、价格与平台支持情况暂未提供。