SuperAPI AI 工具集

documentation-generation-doc-generate

写作与研究

查看项目

更新于 10-15 01:17

技能介绍

用途

该技能是一个文档专家助手,专门从代码中创建全面、可维护的文档。它面向需要自动化文档生成的用户,目标是从代码中提取信息、生成清晰的解释,并在不同类型的文档之间保持一致性。核心关注点是创建与代码保持同步的“活文档”。

主要能力

  • 生成 API 文档、架构图、用户指南和技术参考。
  • 基于 AI 分析和行业最佳实践进行文档生成。
  • 支持构建文档流水线或自动化。
  • 支持统一整个仓库的文档标准。

使用方式

技能要求通过 $ARGUMENTS 接收输入。执行流程包括:

  1. 识别所需的文档类型和目标读者。
  2. 从代码、配置和注释中提取信息。
  3. 使用一致的术语和结构生成文档。
  4. 根据实际路由和当前构建验证生成的示例;仅在请求时添加自动化。
  5. 如果需要详细示例,打开 resources/implementation-playbook.md。

输出格式包括:文档计划和待生成的产物、文件路径和工具配置、假设、缺口和后续任务。

适用场景

  • 从代码生成 API、架构或用户文档。
  • 构建文档流水线或自动化。
  • 统一仓库中的文档标准。

限制与不适用场景

  • 不适用于项目没有代码库或事实来源的情况。
  • 不适用于只需要临时解释的场景。
  • 不适用于无法访问代码或需求的情况。
  • 仅当任务明确匹配上述范围时使用。
  • 不得将输出视为环境特定验证、测试或专家评审的替代品。
  • 如果缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。

安全注意事项

避免在文档中暴露密钥、内部 URL 或敏感数据。

兼容性与维护

该技能是此兼容组的主要编辑路径。完整指令和支持文件保留在本地,以便现有安装继续离线工作。这是一个共享流程,而非额外能力。当现有清单或客户端配置使用可调用 ID 时,应保留该 ID。该技能在 AAS 上于 2026-09-05 修改;原始元数据和许可声明予以保留。

示例与前置条件

对于已更改为返回游标的端点,应检查其实现和测试夹具,更新响应示例和分页说明,然后运行现有的 schema/文档构建,并针对测试夹具运行文档中记录的只读调用。记录实际运行了哪些命令。捆绑的操作手册包含不完整的集成草图,不是已安装的生成器或经过测试的项目模板。

资源

resources/implementation-playbook.md 提供详细示例和模板。