SuperAPI AI 工具集

documentation-generation-doc-generate

写作与研究

查看项目

更新于 10-16 02:08

技能介绍

该技能是一个自动化文档生成工具,侧重于从代码中提取信息并生成可维护、与代码保持同步的文档。

用途

  • 从代码生成 API 文档、架构图、用户指南和技术参考。
  • 构建文档流水线或自动化流程。
  • 在代码库中统一文档标准。

不适用的情况

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

主要能力与工作方式 技能说明给出的指令流程为:识别所需文档类型和目标读者;从代码、配置和注释中提取信息;以一致的术语和结构生成文档;加入自动化(linting、CI)并验证准确性。如需要详细示例,可打开 resources/implementation-playbook.md 获取模板与示例。该技能要求把文档做成与代码同步的“活文档”。

使用与配置 技能接受 $ARGUMENTS 作为需求输入。输出格式包括:文档计划和将生成的产物;文件路径与工具配置;以及假设、缺口和后续任务。

安全 技能明确要求避免在文档中暴露密钥、内部 URL 或敏感数据。

适用场景 适合需要从代码自动产出 API、架构或用户文档,或将文档生成纳入自动化流程、统一仓库文档规范的团队。

限制与未提供信息 技能页面未提供具体的安装命令、支持的编程语言、平台限制、收费与价格信息,这些内容暂未提供。技能使用前提是能够访问代码或需求,并存在代码库或唯一事实来源。