| name | wiki-onboarding |
| description | Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase. Use when user asks for onboarding docs or getting-started guides, user runs /deep-wiki, or user wants to help new team members understand a codebase. |
| type | skill |
| created | 2026-02-27T00:00:00.000Z |
| domain | productivity |
| category | developer-experience |
| risk | unknown |
| source | community |
| tags | ["skill","productivity","developer-experience","wiki","onboarding"] |
Wiki Onboarding Guide Generator
Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase.
When to Use
- User asks for onboarding docs or getting-started guides
- User runs
/deep-wiki:onboard command
- User wants to help new team members understand a codebase
Language Detection
Scan the repository for build files to determine the primary language for code examples:
package.json / tsconfig.json → TypeScript/JavaScript*.csproj / *.sln → C# / .NETCargo.toml → Rustpyproject.toml / setup.py / requirements.txt → Pythongo.mod → Gopom.xml / build.gradle → Java
Guide 1: Principal-Level Onboarding
Audience: Senior/staff+ engineers who need the "why" behind decisions.
Required Sections
- System Philosophy & Design Principles — What invariants does the system maintain? What were the key design choices and why?
- Architecture Overview — Component map with Mermaid diagram. What owns what, communication patterns.
- Key Abstractions & Interfaces — The load-bearing abstractions everything depends on
- Decision Log — Major architectural decisions with context, alternatives considered, trade-offs
- Dependency Rationale — Why each major dependency was chosen, what it replaced
- Data Flow & State — How data moves through the system (traced from actual code, not guessed)
- Failure Modes & Error Handling — What breaks, how errors propagate, recovery patterns
- Performance Characteristics — Bottlenecks, scaling limits, hot paths
- Security Model — Auth, authorization, trust boundaries, data sensitivity
- Testing Strategy — What's tested, what isn't, testing philosophy
- Operational Concerns — Deployment, monitoring, feature flags, configuration
- Known Technical Debt — Honest assessment of shortcuts and their risks
