SuperAPI AI 工具集

reverse-engineer

写作与研究

查看项目

更新于 10-15 23:42

技能介绍

用途:Reverse Engineer(Path-Aware)是“逆向工程到规范驱动开发”流程的第 2 步(共 6 步),前置条件是已完成第 1 步并选好路线,预计耗时 30–45 分钟。它做深度代码库分析,在 docs/reverse-engineering/ 下生成 11 份文档,输出与所用实现框架(Spec Kit、BMAD、BMAD Auto-Pilot)无关,框架选择只影响第 2 步之后。

主要能力:按路线区分内容——Greenfield 只抽取业务逻辑(框架/技术无关),Brownfield 额外记录框架、库、版本、文件路径、配置与 schema 等实现细节。分析覆盖后端(API、数据模型、配置、外部集成、业务逻辑)、前端(页面路由、组件、状态管理、API 客户端、样式)、基础设施(部署、CI/CD、托管、数据库、存储)、测试(框架、类型、覆盖率、测试数据)、业务背景与决策考古(从依赖、配置文件、git 历史、注释推断选型理由)。

生成的 11 个文件:functional-specification.md、integration-points.md、configuration-reference.md、data-architecture.md、operations-guide.md、technical-debt-analysis.md、observability-requirements.md、visual-design-system.md、test-documentation.md、business-context.md、decision-rationale.md,并写入 .stackshift-docs-meta.json 元数据。

使用方式:先读取 .stackshift-state.json 检查 detection_type 与 route,必要时创建输出目录;用 git rev-parse HEAD 记录提交哈希用于增量更新(/stackshift.refresh-docs);先写元数据文件,再为每份文档加含提交哈希与生成时间的头部。触发语如“Reverse engineer the codebase”“Generate comprehensive documentation”。

限制:仅在完成第 1 步并选定路线后使用;业务背景、竞争格局等无法完全从代码确定,需用 [INFERRED]、[NEEDS USER INPUT] 标注;文中未提供收费、定价或平台支持等信息。