SuperAPI AI 工具集

documentation-generation

写作与研究

查看项目

更新于 10-16 01:38

技能介绍

用途:帮助编写与维护技术文档,涵盖 REST 或 GraphQL API 文档、组件库(Storybook)、README、API 参考、架构决策记录(ADR)、开发者入门指南、变更日志与发布说明、配置与环境变量说明,以及部署与运维流程文档;也可用于搭建 Docusaurus、VitePress 等文档站点和编写 JSDoc、TSDoc 行内注释。

主要能力:采用文档即代码思路(版本控制、评审流程、自动生成),倡导从代码生成以保持单一事实来源,并通过自动化检查避免文档过时;提供 OpenAPI/Swagger、TypeDoc、GraphQL schema 描述等生成方式,以及 README、CHANGELOG、JSDoc 等模板示例;还给出文档站点配置、链接检查与代码示例测试的 CI 工作流思路,以及文档清单(必备文档、代码文档、质量与维护项)。

使用方式:资料中的示例包括运行 npx typedoc 生成 TypeScript 文档,配置 typedoc.json 的 entryPoints、out、plugin 等;用 swagger-jsdoc 与 swagger-ui-express 挂载 /api-docs;用 VitePress 或 Docusaurus 的配置文件定义导航与侧边栏;在 GitHub Actions 中用 markdown-link-check 检查 docs 目录断链。

适用场景:需要为项目补充 API 参考、组件库说明、入门教程、变更记录或搭建文档站点时;面向不同读者(使用者、贡献者、运维人员)分层编写。

限制:上述内容来自技能资料示例,未提供具体安装命令之外的部署细节、收费方式、平台支持范围或效果保证;实际使用需按项目技术栈与环境调整。