用途:为代码库生成两份互补的上手文档,覆盖从新成员到首席工程师的理解需求。当用户请求上手文档或入门指南、运行 /deep-wiki:onboard 命令、或希望帮助新成员理解代码库时使用。
语言检测:扫描仓库构建文件确定代码示例主语言,如 package.json / tsconfig.json 对应 TypeScript/JavaScript,*.csproj / *.sln 对应 C#/.NET,Cargo.toml 对应 Rust,pyproject.toml / setup.py / requirements.txt 对应 Python,go.mod 对应 Go,pom.xml / build.gradle 对应 Java。
指南一:首席级上手。面向高级工程师,重点解释决策背后的“为什么”。章节包括系统哲学与设计原则、含 Mermaid 图的架构概览、关键抽象与接口、决策日志、依赖选择理由、数据流与状态、失败模式与错误处理、性能特征、安全模型、测试策略、运维关注点、已知技术债。规则:每条论断附 (file_path:line_number) 引用;至少三张 Mermaid 图(架构、数据流、依赖图);图使用暗色模式配色;聚焦决策原因而非仅描述现状。
指南二:零到英雄贡献者指南。面向新贡献者,提供逐步实操指导。章节包括项目简介、前置条件、环境搭建(含精确命令与每步预期输出)、项目结构注释树、首个任务端到端演示、开发工作流(分支策略、提交规范、PR 流程)、运行测试、调试指南、关键概念、代码模式模板、常见陷阱、求助渠道、术语表、快速参考卡。规则:代码示例使用检测到的主语言;命令可复制粘贴;含验证步骤的预期输出;工作流用暗色模式 Mermaid 图;论断基于实际代码并附引用。
限制:仅在任务明确匹配上述范围时使用;输出不能替代特定环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。