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

指南 1：首席工程师级别的入门指南

受众：需要了解决策背后“原因”的高级/资深工程师。

必需章节

1. 系统理念与设计原则 — 系统维持哪些不变量？关键设计选择是什么，为什么这样选择？
2. 架构概览 — 使用 Mermaid 图展示组件关系。各组件由谁负责，采用什么通信模式？
3. 关键抽象与接口 — 系统赖以运行的核心抽象
4. 决策日志 — 主要架构决策及其背景、考虑过的替代方案和权衡
5. 依赖项选择依据 — 选择每个主要依赖项的原因，以及它取代了什么
6. 数据流与状态 — 数据如何在系统中流动（根据实际代码追踪，而非猜测）
7. 故障模式与错误处理 — 哪些情况会出错、错误如何传播、有哪些恢复模式
8. 性能特征 — 瓶颈、扩展限制、热点路径
9. 安全模型 — 身份验证、授权、信任边界、数据敏感性
10. 测试策略 — 测试了什么、没有测试什么、测试理念
11. 运维注意事项 — 部署、监控、功能标志、配置
12. 已知技术债务 — 坦诚评估权宜之计及其风险

规则

• 每项陈述都必须附有 (file_path:line_number) 引用
• 至少包含 3 张 Mermaid 图（架构图、数据流图、依赖关系图）
• 所有 Mermaid 图都使用深色模式配色（参见 wiki-vitepress 技能）
• 只有在提交历史、ADR 或负责人的证据能够支持相关理由时，才说明“为什么”。明确标注推断出的理由和未知的性能/安全属性；仅凭源码结构无法确定设计意图或测量结果。

指南 2：从零到精通的贡献者指南

受众：需要循序渐进的实用指导的新贡献者。

必需章节

1. 项目功能 — 用 2-3 句话简要介绍项目
2. 前置条件 — 所需工具、版本和账户
3. 环境设置 — 分步说明，附准确命令和每一步的预期输出
4. 项目结构 — 带注释的目录树（说明各处内容及其用途）
5. 你的第一个任务 — 端到端演示如何添加一个简单功能
6. 开发工作流 — 分支策略、提交规范、PR 流程
7. 运行测试 — 如何运行测试、测试什么、如何添加测试
8. 调试指南 — 常见问题及诊断方法
9. 关键概念 — 结合代码示例解释领域专用术语
10. 代码模式 — “如果要添加 X，请遵循此模式”的模板
11. 常见陷阱 — 每位新贡献者都会犯的错误，以及如何避免
12. 获取帮助 — 沟通渠道、文档、关键联系人
13. 术语表 — 代码库中不易理解的术语
14. 快速参考卡 — 最常用命令和模式的速查表

规则

• 所有代码示例都使用检测到的主要语言
• 每条命令都必须可直接复制粘贴
• 在验证步骤中注明预期输出
• 工作流图使用 Mermaid（深色模式配色）
• 所有陈述都必须以实际代码为依据，并引用 (file_path:line_number)

适用场景

此技能适用于执行概述中所述的工作流或操作。

示例

用户请求：

创建入职文档，帮助新工程师运行、了解并安全地修改此代码库。

限制

• 仅当任务明确符合上述范围时，才使用此技能。
• 不要将输出视为环境特定验证、测试或专家审查的替代品。
• 如果缺少必要的输入、权限、安全边界或成功标准，请暂停并请求澄清。