SuperAPI AI 工具集

acquire-codebase-knowledge

编程与开发

查看项目

更新于 10-16 00:22

技能介绍

用途:当用户明确要求梳理、记录或上手现有代码库时使用,例如 map this codebase、document 等提示。它会产出七份文档,覆盖有效参与项目所需信息,且只记录可从文件或终端输出验证的内容,不推断、不假设。

主要能力:输出契约要求 docs/codebase/ 中恰好存在 STACK.md、STRUCTURE.md、ARCHITECTURE.md、CONVENTIONS.md、INTEGRATIONS.md、TESTING.md、CONCERNS.md 七个文件;每条断言可追溯到源文件、配置或终端输出;未知项标记 [TODO],依赖团队意图的标记 [ASK USER];每份文档附证据文件路径列表;最终回复包含编号的 [ASK USER] 问题与意图和现状的偏差。

使用方式:工作流分四阶段——扫描并阅读意图文档、逐领域调查、填充七份文档、校验修复验证。第一阶段在目标项目根目录运行:python3 "$SKILL_ROOT/scripts/scan.py" --output docs/codebase/.codebase-scan.txt;并搜索阅读 PRD、TRD、README、ROADMAP、SPEC、DESIGN 文件。支持焦点领域模式,此时仍完整执行第一阶段,先完成焦点文档,未分析文档保留必需章节并标 [TODO],最后仍对七份文档跑校验。可按默认模式只填核心必需章节,或按仓库复杂度启用扩展模式。

适用场景:现有代码库的上手、梳理与文档化,尤其适合需要区分生产依赖与开发工具、识别脆弱与高改动文件、分离测试缺口与生产债的场合。

限制与注意:仅记录源码约定,不记录 dist/、build/、generated/、.next/、out/、pycache/ 等生成产物;README 可能描述意图架构而非现状,需与真实结构交叉核对;TypeScript 路径别名需映射到真实路径;.env.example 等用于发现必需环境变量;单仓库需按子包分别映射。属 AIX skill pack,别名 aix-acquire-codebase-knowledge,生成物写入 .aix/,写前需 mkdir -p .aix,默认可能被覆盖,除明确要求外不写入项目根目录。扫描脚本要求 Python 3.8+。