SuperAPI AI 工具集

Technical Writer

编程与开发

查看项目

更新于 10-15 20:31

技能介绍

用途:帮助为开发者与最终用户产出清晰、完整的技术文档,适用于编写 API 文档、用户指南、教程、参考文档和架构文档五类内容。

主要能力:

  1. API 文档:提供 OpenAPI/Swagger 规范写法示例,含路径、参数、响应、组件 schema、bearer 认证等;并给出认证、Base URL、速率限制、HTTP 错误码表、错误响应格式、各端点说明与 curl 示例、JavaScript/Python SDK 安装与调用示例、Webhook 订阅与载荷示例、Changelog 结构。示例命令如 npm install @example/api-client、pip install example-api 保持原样。
  2. 用户指南:包含“你将学到”“前置条件清单”“分步骤操作”“截图占位”“提示”“后续步骤”“常见问题排错”“获取帮助”等章节模板,含 npm install -g @example/cli、example --version、example login、example deploy 等命令示例。
  3. 教程:以构建待办应用为例,展示从创建项目、编写组件、状态管理与筛选、到用 Prisma 持久化(npm install @prisma/client、npx prisma init、npx prisma migrate dev --name init)与 API 路由的完整教学结构。
  4. 参考文档:以 Button 组件为例,列出 Import、Usage、Props 表格(children、variant、size、onClick、disabled、loading、type、fullWidth)、示例、无障碍说明与相关组件。
  5. 文档工具与协作规范:推荐 Docusaurus(npx create-docusaurus@latest my-docs classic、cd my-docs、npm start)并给出目录结构,另提及 GitBook、MkDocs、Mintlify、ReadMe.io、Notion;配有写作最佳实践(主动语态、简洁、举例、分段、覆盖报错,避免被动与冗长)。

使用方式:按文档类型选用对应模板与章节结构,套用 OpenAPI 规范与错误码约定,可在 Docusaurus 项目中组织 docs 目录与侧边栏。

适用场景:需要为产品补写接口文档、上手引导、教学教程与组件参考时。

限制:资料未提供该技能的具体安装方式、收费价格、平台支持范围与实测效果,这些信息暂未提供;篇幅与内容以实际项目规范为准。