# Wiki Onboarding

> 生成两份互补的入职文档，共同为任何工程师（从新人到首席）提供代码库的完整理解。当用户请求入职文档或入门指南、运行 /deep-wiki 命令，或希望帮助新团队成员理解代码库时使用。触发词：onboarding、入门指南、getting-started、wiki、代码库介绍、新人入职、/deep-wiki、deep-wiki:onboard

- Skill: `kscz0000/wiki-onboarding` (Agent Skill)
- Install (CLI): `npx skillmds@latest add kscz0000/wiki-onboarding`
- Raw SKILL.md: https://api.skillmd.com/api/skills/kscz0000/wiki-onboarding/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: kscz0000 (https://skillmd.com/u/kscz0000)
- Updated: 2026-09-21
- Page: https://skillmd.com/skills/kscz0000/wiki-onboarding

---


# Wiki 入职指南生成器

生成两份互补的入职文档，共同为任何工程师（从新人到首席）提供代码库的完整理解。

## 适用场景
- 用户请求入职文档或入门指南
- 用户运行 `/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

## 指南一：首席级入职

**目标读者**：需要了解决策背后"为什么"的资深/Staff+ 工程师。

### 必备章节

1. **系统哲学与设计原则** — 系统维护哪些不变量？关键设计选择是什么，原因何在？
2. **架构概览** — 包含 Mermaid 图的组件映射。什么归属什么，通信模式如何。
3. **核心抽象与接口** — 一切所依赖的承重抽象
4. **决策日志** — 重大架构决策，附带上下文、考虑过的替代方案、权衡取舍
5. **依赖选型理由** — 为何选择每个主要依赖，它替代了什么
6. **数据流与状态** — 数据如何在系统中流转（从实际代码中追踪，而非猜测）
7. **故障模式与错误处理** — 哪些会出错，错误如何传播，恢复模式
8. **性能特征** — 瓶颈、扩展极限、热路径
9. **安全模型** — 认证、授权、信任边界、数据敏感性
10. **测试策略** — 测试了什么，没测试什么，测试理念
11. **运维关注点** — 部署、监控、特性开关、配置
12. **已知技术债** — 对捷径及其风险的诚实评估

### 规则
- 每个论断都需要 `(file_path:line_number)` 引用作为支撑
- 至少 3 张 Mermaid 图（架构、数据流、依赖图）
- 所有 Mermaid 图使用深色模式配色（参见 wiki-vitepress 技能）
- 聚焦于决策背后的"为什么"，而非仅仅存在的"是什么"

## 指南二：零基础贡献者指南

**目标读者**：需要逐步实操指导的新贡献者。

### 必备章节

1. **项目简介** — 2-3 句电梯演讲
2. **前置条件** — 所需的工具、版本、账号
3. **环境搭建** — 逐步操作，每步附带精确命令与预期输出
4. **项目结构** — 带注释的目录树（每个目录放什么、为什么）
5. **你的第一个任务** — 添加简单功能的端到端演练
6. **开发工作流** — 分支策略、提交规范、PR 流程
7. **运行测试** — 如何运行测试、测试什么、如何添加测试
8. **调试指南** — 常见问题及诊断方法
9. **关键概念** — 用代码示例解释领域特定术语
10. **代码模式** — "如果想添加 X，遵循此模式"模板
11. **常见陷阱** — 每个新贡献者都会犯的错误及避免方法
12. **求助渠道** — 沟通频道、文档、关键联系人
13. **术语表** — 代码库中使用但不够直观的术语
14. **速查卡** — 最常用命令与模式的速查表

### 规则
- 所有代码示例均使用检测到的主要语言
- 每条命令都必须可直接复制粘贴
- 验证步骤需包含预期输出
- 使用 Mermaid 绘制工作流图（深色模式配色）
- 所有论断基于实际代码 — 引用 `(file_path:line_number)`

## 适用场景
本技能适用于执行概览中所述的工作流或操作。

## 限制
- 仅在任务明确匹配上述范围时使用本技能。
- 请勿将输出视为特定环境验证、测试或专家评审的替代。
- 若缺少必需的输入、权限、安全边界或成功标准，请停下并询问澄清。