SuperAPI AI 工具集

recipe-reverse-engineer

写作与研究

查看项目

更新于 10-16 02:41

技能介绍

用途

该技能用于对已有代码库进行逆向工程,自动生成产品需求文档(PRD)和设计文档(Design Doc)。它面向需要为遗留系统、未文档化项目或已有实现补充文档的场景,通过结构化的多代理工作流,从代码中提取功能范围并产出可评审的文档。

主要能力

  • 范围发现:通过 scope-discoverer 子代理扫描目标代码库,识别功能单元,并将其分组为 PRD 单元。
  • PRD 生成:由 prd-creator 子代理基于代码调查生成逆向工程 PRD。
  • 代码验证:由 code-verifier 子代理校验文档与代码实现的一致性,提供完整性基线。
  • 文档评审:由 document-reviewer 子代理结合验证证据对文档进行评审。
  • 条件修订:当评审产生可执行发现时,由 prd-creator 或 technical-designer 进行修订,并重新验证与评审。
  • 设计文档生成:支持标准模式(每个 PRD 单元对应一份设计文档)和全栈模式(每个单元生成后端与前端两份设计文档)。
  • 编排协调:以编排者身份按顺序调用各子代理,逐步推进,并设有质量门禁和人工评审点。

使用方式

该技能以工作流形式执行,主要步骤包括:

  1. 初始配置:确认目标路径、文档深度(仅 PRD 或 PRD + 设计文档)、参考架构(layered / mvc / clean / hexagonal / none)、是否启用人工评审、是否启用全栈设计,并配置输出目录(PRD 输出至 docs/prd/ 或已有目录,设计文档输出至 docs/design/ 或已有目录)。
  2. 阶段一:PRD 生成:先执行范围发现(单次统一扫描,分组为 PRD 单元,可人工评审),然后对每个单元依次执行生成、验证、评审、修订循环。
  3. 阶段二:设计文档生成(如请求):复用阶段一的发现结果进行范围映射,然后对每个单元依次执行生成、验证、评审、修订循环。全栈模式下每个单元生成后端和前端两份设计文档。
  4. 最终报告:输出生成文档汇总表、行动项、被拒绝的可执行发现及下一步清单。

工作流中会调用多个子代理,包括 dev-workflows:scope-discoverer、dev-workflows:prd-creator、dev-workflows:code-verifier、dev-workflows:document-reviewer、dev-workflows:technical-designer 以及 dev-workflows-frontend:technical-designer-frontend。

适用场景

  • 为已有代码库补充 PRD 和设计文档。
  • 对遗留系统进行逆向工程,梳理功能范围与架构。
  • 需要从代码实现中提取文档并经过验证与评审的团队。
  • 支持全栈项目,可分别生成后端与前端设计文档。

限制

  • 需要用户明确授权每个子代理调用。
  • 范围发现若未发现任何单元,需用户提供项目结构提示。
  • 生成失败会记录并继续其他单元,最终在汇总中报告。
  • 验证不一致或库存未覆盖时,需强制人工评审并明确批准。
  • 具体收费、价格、平台支持等信息暂未提供。