SuperAPI AI 工具集

code-documentation-doc-generate

写作与研究

查看项目

更新于 10-15 03:29

技能介绍

用途

该技能面向文档自动化生成场景,目标是从代码中提取信息,生成清晰、可维护、且与代码保持同步的“活文档”。可用于生成 API 文档、架构图、用户指南和技术参考。

适用场景

  • 从代码生成 API、架构或用户文档
  • 构建文档流水线或自动化
  • 在仓库范围内统一文档规范

不适用场景

  • 项目没有代码库或事实来源
  • 只需要临时性解释
  • 无法访问代码或需求

主要能力

技能会根据需求确定文档类型与目标读者,从代码、配置和注释中提取信息,并以一致的术语和结构生成文档。生成的示例会对实际路由和当前构建做校验;只有在被要求时才添加自动化。若需要详细示例,会打开 resources/implementation-playbook.md。

使用方式

技能以 $ARGUMENTS 接收需求输入。基本流程包括:识别所需文档类型和目标受众;从代码、配置和注释中提取信息;按一致术语与结构生成文档;对照实际路由和当前构建验证生成的示例,按需添加自动化;需要详细示例时参考 resources/implementation-playbook.md。

别名与维护

该技能是 documentation-generation-doc-generate 的兼容别名;在没有既有契约要求时,新引用应使用后者。完整指令与支持文件保留在本地,因此既有安装可继续离线工作。这是一套共享流程,并非额外能力。当既有 manifest 或客户端配置使用该 ID 时,应保留可调用 ID。AAS 于 2026-09-05 修改;原始元数据和许可声明均已保留。

示例与前置条件

资料给出的示例:当某端点改为返回游标(cursor)时,检查其实现和测试夹具,更新响应示例与分页说明,然后运行已有的 schema/文档构建,并对测试夹具执行文档中记录的只读调用;记录实际运行了哪些命令。随附的 playbook 包含不完整的集成草图,并非已安装的生成器或经过测试的项目模板。

安全与限制

  • 避免在文档中暴露密钥、内部 URL 或敏感数据。
  • 仅在任务明确匹配上述范围时使用本技能。
  • 不得将输出视为针对具体环境的验证、测试或专家评审的替代品。
  • 若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。

输出格式

  • 文档计划与要生成的产物
  • 文件路径与工具配置
  • 假设、缺口与后续任务