Agent Skills
返回列表
💻

代码文档生成助手

开发编程 更新于 2026.08.30

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @kunlungrowth/kg-code-documenter。

技能介绍

要解决什么问题

函数签名改了，docstring 还停留在上一版；内部 API 上线了，团队却拿不出一份能跑通的 OpenAPI 规范；用户指南写着「支持批量导出」，代码里根本没有这个参数。文档与代码脱节的根源在于：文档靠人手写、事后补，而不是从代码里「长」出来的。

它如何工作

这个技能把文档生成拆成一条五步流水线：

  • 明确受众：先判断读者是开发者还是终端用户，再决定文档的深度与措辞
  • 抽取信息：扫描函数签名、参数、返回值与抛出的异常
  • 编写文档：按模板产出 docstring、OpenAPI/Swagger 规范或 JSDoc
  • 校验一致性：核对文档与代码是否吻合，示例能否真实运行
  • 输出工件：返回结构化的 DocArtifact，可交给下游 api-designer 继续对齐规范

输出分两部分：完整的结构化工件，外加一段自然语言摘要，内含质量自检和最该改的 2-3 个点。

适用边界

  • 不做幻觉：不会编造代码里不存在的 API 行为，遇到缺失信息会停下来而不是「猜」
  • 示例必须可执行：拒绝占位符式伪代码，示例应能在真实环境中跑通
  • 输入要具体：需求描述越贴近实际代码，产出越准；一句空泛的「帮我写文档」只能得到模板骨架

使用场景

  • 接手一个没有文档的内部API，需要快速生成OpenAPI规范并补充鉴权和错误码说明
  • 给一个遗留Python模块的每个函数补写docstring，确保参数和异常描述与代码一致
  • 为一个开源库产出用户指南，覆盖安装、基础用法和常见错误场景
  • 为一组REST接口编写Swagger文档，要求每个接口的示例请求都能真实跑通

适合人员

  • 后端开发者，需要为没有文档的遗留API补全OpenAPI规范
  • 开源库维护者，需要为项目产出一份能跑通的用户指南
  • 技术文档工程师，需要从代码中自动生成docstring并校验一致性
  • API平台负责人，需要确保接口文档的示例请求真实可执行