用途:当用户明确要求映射、记录、检查、分析、理解或上手一个既有代码库或仓库时使用,用于上手、架构发现、技术评审和长期维护。
模式选择:执行前必须让用户按编号单选一种模式,只接受数字输入。1=Quick Update,聚焦最新变更,仅原地更新受影响章节;2=Standard Refresh,执行完整范围扫描并原地刷新现有文档;3=Rebuild Docs,在 .lcs/codebase/ 中从零重建全部七份文档。未选定前不得开始 Phase 1;输入无效则再询问一次同样三个选项;有效后打印 Selected mode: <name> 再继续。模式 1 或 2 不得整体覆盖已有文件,仅原地更新章节;整体重生成仅允许在模式 3。
主要能力与输出:需在 .lcs/codebase/ 下生成 STACK.md、STRUCTURE.md、ARCHITECTURE.md、CONVENTIONS.md、INTEGRATIONS.md、TESTING.md、CONCERNS.md,以及 Phase 4 写出的 CHAIN-OF-TRUTH.md。所有结论只能基于可验证证据(源文件、清单、配置、文档、git 历史或终端输出),每份文档需附含具体文件路径的 Evidence 章节;缺证据用 [TODO],涉及产品/团队意图、归属或需人工确认的决策用 [ASK USER];须区分陈述意图与实际实现,不得猜测或编造架构。
工作流:Phase 1 创建 .lcs/codebase/、运行扫描脚本、读取 .lcs/docs/ 意图文档(如 README、PRD、TRD、ROADMAP、SPEC、DESIGN、ARCHITECTURE、CONTRIBUTING、ADR 等),缺失则标 [TODO] 或 [ASK USER];Phase 2 依据扫描输出与直接检查进行调查(语言/运行时、包管理器、依赖分类、入口点与目录结构、架构边界与约定、集成与环境配置、测试与 CI/CD、容器化、安全合规工具、性能标记、TODO/FIXME/HACK、git 高变更文件等问题与检查点见 references/inquiry-checkpoints.md 与 stack-detection.md);Phase 3 按顺序填充模板;Phase 4 校验每份文档、修正无依据结论、汇总 [ASK USER] 编号问题、标注意图与实现偏差,并写入 Chain of Truth 报告。
必要命令示例:Unix 类 mkdir -p .lcs/codebase,python3 "$SKILL_ROOT/scripts/scan.py" --output .lcs/codebase/.codebase-scan.txt;PowerShell New-Item -ItemType Directory -Force -Path ".lcs/codebase"、python "$SKILL_ROOT/scripts/scan.py" --output .lcs/codebase/.codebase-scan.txt;Windows 无 python 时可用 py -3 "$SKILL_ROOT/scripts/scan.py" --output .lcs/codebase/.codebase-scan.txt。$SKILL_ROOT 为 skills/lcs-codebase-doc 的绝对路径。
适用范围与限制:调查仅限项目源码、配置与清单;忽略隐藏目录(.lcs 除外),.lcs 内仅读 .lcs/docs/ 作为意图来源;允许根目录点文件;不检查 .github/,不检查 skills/、vendor/ 及生成/依赖/构建/缓存目录。monorepo 需检查 workspaces/packages/apps/services 与包级清单,不能以根清单代表整个仓库;不得仅凭环境变量名推断数据库;不得将生成输出目录记为源码约定;需区分生产与开发依赖;测试中的 TODO 视为测试缺口;不得暴露密钥,仅依据 .env.example 等记录变量名;仓库过大时优先清单、入口、核心源码、测试设置、CI/CD 与集成边界;若 CI/安全证据仅存在于被跳过的隐藏目录,相关项标 [TODO]。
重点区域模式:用户只要求部分领域时,仍完整执行 Phase 1,先完成所需文档,但仍创建全部七份,非重点文档保留章节并将未决部分标 [TODO],最后对七份文档做完整 Phase 4 校验。
交接信息:建议下一技能 lcs-doc-finalizer,下一文件 .lcs/codebase/CHAIN-OF-TRUTH.md;当前阶段 codebase_documentation,置信度 medium;已知风险为未验证结论标 [TODO]、缺失意图文档可能降低准确性。收费、价格与平台信息暂未提供。