SuperAPI AI 工具集

code-documenter

办公与效率

查看项目

更新于 10-16 02:32

技能介绍

用途:该技能面向内联文档、API 规范、文档站点与开发者指南的编写,适用于为函数和类添加 docstring、创建 OpenAPI/Swagger 文档、搭建 Docusaurus、MkDocs、VitePress 文档站、编写交互式 API 门户(Swagger UI、Redoc、Stoplight)、入门指南与教程,以及记录 REST、GraphQL、WebSocket、gRPC 等多协议 API 和生成文档覆盖率报告。

主要能力:按语言与框架识别文档策略,支持 Google、NumPy、Sphinx 风格 Python docstring 与 TypeScript JSDoc;支持 FastAPI、Django、NestJS、Express 的 API 文档模式;支持 OpenAPI 3.0/3.1、AsyncAPI、gRPC/protobuf;可生成覆盖率报告与文档站点配置。

使用方式:核心工作流为发现(询问格式偏好与排除项)、检测(识别语言与框架)、分析(找出未文档化代码)、文档化(应用统一格式)、报告(生成覆盖率摘要)。技能会按上下文加载对应参考文件,如 python-docstrings.md、typescript-jsdoc.md、api-docs-fastapi-django.md、api-docs-nestjs-express.md、coverage-reports.md、documentation-systems.md、interactive-api-docs.md、user-guides-tutorials.md。输出形式包括已文档化文件加覆盖率报告、OpenAPI 规范加门户配置、站点配置加内容结构与构建说明、结构化 Markdown 指南与教程。

限制与约束:开始前必须询问 docstring 格式偏好,不得擅自假设;必须为所有公共函数和类编写文档,包含参数类型与描述、异常/错误说明,并测试文档中的代码示例;不得使用与框架不匹配的 API 文档策略,不得编写不准确或未经验证的文档,不得省略错误文档,不得冗长记录显而易见的 getter/setter,也不得产出难以维护的文档。具体安装命令与价格信息暂未提供。