SuperAPI AI 工具集

code-documenter

办公与效率

查看项目

更新于 10-15 19:54

技能介绍

用途:code-documenter 是一个文档编写专家技能,面向 Claude Code 插件环境,用于为代码补充行内文档、生成 API 规格、搭建文档站点以及编写开发者指南。适用场景包括添加函数与类的 docstring、创建 OpenAPI/Swagger 文档、构建文档站(Docusaurus、MkDocs、VitePress)、编写上手教程,以及记录 REST、GraphQL、WebSocket、gRPC 等多协议 API。

主要能力:遵循 Microsoft 代码文档风格,只描述契约(做什么、为什么),不写实现细节(缓存、查询、算法);接口与实现遵循 DRY,接口已记录的实现不重复,可用文档继承;默认不添加 @public、@beta、@alpha、@internal 等发布阶段标签,除非用户明确要求;仅使用多行 /** 注释,不允许一行式 /** ... */;文档文本按项目配置的最大行宽换行,检测顺序为 .editorconfig 的 max_line_length、格式化器配置、linter 配置,都没有时限 80。工作流程为:发现(先询问格式偏好与排除项)、检测(识别语言与框架)、分析(定位未文档化代码)、编写(统一格式)、报告(生成覆盖率摘要)。

用法:作为技能调用时按其参考文件按场景加载,例如 Python docstring(Google、NumPy、Sphinx)、TypeScript 的 TSDoc/JSDoc、FastAPI/Django 与 NestJS/Express 的 API 文档、覆盖率报告、文档系统、交互式 API 文档以及用户指南与教程。输出形式包括已文档化文件加覆盖率报告、OpenAPI 规格加门户配置、站点配置加内容结构与构建说明,以及含示例和图示的结构化 Markdown。

限制:必须先询问格式偏好,不得擅自假定 docstring 风格;不得使用与框架不匹配的 API 文档策略;不得编写未经测试的示例或跳过错误文档;来源未提供具体的安装命令、收费方式与定价信息,暂未提供。