
关于
生成两份互补的入职文档,让任何工程师(从新人到首席)全面理解代码库。适用于用户需要入职文档、入门指南或帮助新团队成员理解代码库。
name: wiki-onboarding description: "生成两份互补的入职文档,共同为任何工程师(从新人到首席工程师)提供对代码库的完整理解。当用户请求入职文档或入门指南、用户运行 /deep-wiki 或用户希望帮助新团队成员理解代码库时使用。" risk: unknown source: community date_added: "2026-02-27"
Wiki 入职指南生成器
生成两份互补的入职文档,共同为任何工程师(从新人到首席工程师)提供对代码库的完整理解。
何时使用
- 用户请求入职文档或入门指南
- 用户运行
/deep-wiki:onboard命令 - 用户希望帮助新团队成员理解代码库
语言检测
扫描仓库中的构建文件以确定代码示例的主要语言:
package.json/tsconfig.json→ TypeScript/JavaScript*.csproj/*.sln→ C# / .NETCargo.toml→ Rustpyproject.toml/setup.py/requirements.txt→ Pythongo.mod→ Gopom.xml/build.gradle→ Java
指南 1:首席工程师级别入职
受众:需要了解决策背后"为什么"的高级/Staff+ 工程师。
必需章节
- 系统哲学与设计原则 — 系统维护哪些不变量?关键设计选择是什么,为什么?
- 架构概览 — 带 Mermaid 图的组件映射。什么拥有什么,通信模式。
- 关键抽象与接口 — 所有东西都依赖的承重抽象
- 决策日志 — 主要架构决策及其上下文、考虑的替代方案、权衡
- 依赖理由 — 为什么选择每个主要依赖,它替代了什么
- 数据流与状态 — 数据如何在系统中流动(从实际代码追踪,而非猜测)
- 故障模式与错误处理 — 什么会出错,错误如何传播,恢复模式
- 性能特征 — 瓶颈、扩展限制、热路径
- 安全模型 — 认证、授权、信任边界、数据敏感性
- 测试策略 — 测试了什么,没测试什么,测试理念
- 运维关注点 — 部署、监控、功能开关、配置
- 已知技术债务 — 对捷径及其风险的诚实评估
规则
- 每个声明都有
(file_path:line_number)引用支持 - 至少 3 个 Mermaid 图(架构、数据流、依赖图)
- 所有 Mermaid 图使用深色模式颜色(参见 wiki-vitepress skill)
- 关注决策的原因,而不仅仅是存在什么
指南 2:从零到精通贡献者指南
受众:需要逐步实践指导的新贡献者。
必需章节
- 项目做什么 — 2-3 句电梯演讲
- 前置条件 — 需要的工具、版本、账户
- 环境搭建 — 逐步精确命令,每步的预期输出
- 项目结构 — 带注释的目录树(什么在哪里以及为什么)
- 你的第一个任务 — 添加简单功能的端到端演练
- 开发工作流 — 分支策略、提交规范、PR 流程
- 运行测试 — 如何运行测试、测试什么、如何添加测试
- 调试指南 — 常见问题及如何诊断
- 关键概念 — 用代码示例解释的领域特定术语
- 代码模式 — "如果你想添加 X,遵循这个模式"模板
- 常见陷阱 — 每个新贡献者都会犯的错误及如何避免
- 获取帮助 — 沟通渠道、文档、关键联系人
- 术语表 — 代码库中使用的不明显术语
- 快速参考卡 — 最常用命令和模式的速查表
规则
- 所有代码示例使用检测到的主要语言
- 每个命令必须可直接复制粘贴
- 验证步骤包含预期输出
- 工作流图使用 Mermaid(深色模式颜色)
- 所有声明基于实际代码 — 引用
(file_path:line_number)
何时使用
此技能适用于执行概述中描述的工作流或操作。
限制
- 仅在任务明确匹配上述描述的范围时使用此技能。
- 不要将输出视为环境特定验证、测试或专家审查的替代品。
- 如果缺少必需的输入、权限、安全边界或成功标准,请停下来请求澄清。
兼容工具
Claude CodeCursor
标签
前端开发