用途:当用户明确要求映射、记录或熟悉现有代码库时使用,例如“map this codebase”“document…”。产出 docs/codebase/ 下七份文档,覆盖有效参与项目所需信息。只记录可从文件或终端输出验证的内容,不推断、不假设。
主要能力:输出契约要求 docs/codebase/ 中恰好存在 STACK.md、STRUCTURE.md、ARCHITECTURE.md、CONVENTIONS.md、INTEGRATIONS.md、TESTING.md、CONCERNS.md;每条结论可追溯到源文件、配置或终端输出;未知项标 [TODO],依赖意图的决策标 [ASK USER];每份文档含简短 evidence 列表与具体文件路径;最终回复包含编号的 [ASK USER] 问题及意图与现实的偏差。
使用方式:工作流分四阶段。Phase 1 在项目根运行扫描脚本:python3 "$SKILL_ROOT/scripts/scan.py" --output docs/codebase/.codebase-scan.txt($SKILL_ROOT 为技能文件夹绝对路径,支持 Windows、macOS、Linux),并查找阅读 PRD、TRD、README、ROADMAP、SPEC、DESIGN 文件,先总结声明的项目意图。Phase 2 依据扫描输出回答七套模板问题,加载 references/inquiry-checkpoints.md;栈不明确时加载 references/stack-detection.md。Phase 3 从 assets/templates/ 复制模板到 docs/codebase/,按 STACK、STRUCTURE、ARCHITECTURE、CONVENTIONS、INTEGRATIONS、TESTING、CONCERNS 顺序填写。Phase 4 运行强制校验循环,修复后重跑,直至七份文档全部通过,再汇总并列出所有 [ASK USER] 问题与意图偏差。若用户指定聚焦领域(如“architecture only”),仍完整运行 Phase 1,优先完成聚焦文档,未分析的非聚焦文档保留必需章节并标 [TODO],最终仍对七份文档执行 Phase 4 校验。
适用场景:现有代码库的梳理、文档化与新人上手;单体仓库、README 过时、TypeScript 路径别名、生成/编译产物、.env.example、devDependencies 与生产栈区分、测试 TODO 与生产债务区分、高变更文件等情形均有对应注意事项。
限制:仅记录可验证内容;不得把 dist/、build/、generated/、.next/、out/、pycache 等产物当作约定;不得凭变量名猜测数据库;扫描脚本需 Python 3.8+;模板默认只完成“Core Sections (Required)”,仅在仓库复杂度足够时启用扩展模式。其他收费、平台与效果信息暂未提供。