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 Activate
- 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# / .NET
Cargo.toml → Rust
pyproject.toml / setup.py / requirements.txt → Python
go.mod → Go
pom.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
Rules
- Every claim backed by
(file_path:line_number) citation
- Minimum 3 Mermaid diagrams (architecture, data flow, dependency graph)
- All Mermaid diagrams use dark-mode colors (see wiki-vitepress skill)
- Focus on WHY decisions were made, not just WHAT exists
Guide 2: Zero-to-Hero Contributor Guide
Audience: New contributors who need step-by-step practical guidance.
Required Sections
- What This Project Does — 2-3 sentence elevator pitch
- Prerequisites — Tools, versions, accounts needed
- Environment Setup — Step-by-step with exact commands, expected output at each step
- Project Structure — Annotated directory tree (what lives where and why)
- Your First Task — End-to-end walkthrough of adding a simple feature
- Development Workflow — Branch strategy, commit conventions, PR process
- Running Tests — How to run tests, what to test, how to add a test
- Debugging Guide — Common issues and how to diagnose them
- Key Concepts — Domain-specific terminology explained with code examples
- Code Patterns — "If you want to add X, follow this pattern" templates
- Common Pitfalls — Mistakes every new contributor makes and how to avoid them
- Where to Get Help — Communication channels, documentation, key contacts
- Glossary — Terms used in the codebase that aren't obvious
- Quick Reference Card — Cheat sheet of most-used commands and patterns
Rules
- All code examples in the detected primary language
- Every command must be copy-pasteable
- Include expected output for verification steps
- Use Mermaid for workflow diagrams (dark-mode colors)
- Ground all claims in actual code — cite
(file_path:line_number)
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
1---2name: wiki-onboarding3description: "Generates two complementary onboarding guides \u2014 a Principal-Level architectural deep-dive and a Zero-to-Hero contributor walkthrough. Use when the user wants onboarding documentation fo..."4risk: unknown5source: community6metadata:7 source: https://skillmd.com/skills/mayurrathi/wiki-onboarding8---910# Wiki Onboarding Guide Generator1112Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase.1314## When to Activate1516- User asks for onboarding docs or getting-started guides17- User runs `/deep-wiki:onboard` command18- User wants to help new team members understand a codebase1920## Language Detection2122Scan the repository for build files to determine the primary language for code examples:23- `package.json` / `tsconfig.json` → TypeScript/JavaScript24- `*.csproj` / `*.sln` → C# / .NET25- `Cargo.toml` → Rust26- `pyproject.toml` / `setup.py` / `requirements.txt` → Python27- `go.mod` → Go28- `pom.xml` / `build.gradle` → Java2930## Guide 1: Principal-Level Onboarding3132**Audience**: Senior/staff+ engineers who need the "why" behind decisions.3334### Required Sections35361. **System Philosophy & Design Principles** — What invariants does the system maintain? What were the key design choices and why?372. **Architecture Overview** — Component map with Mermaid diagram. What owns what, communication patterns.383. **Key Abstractions & Interfaces** — The load-bearing abstractions everything depends on394. **Decision Log** — Major architectural decisions with context, alternatives considered, trade-offs405. **Dependency Rationale** — Why each major dependency was chosen, what it replaced416. **Data Flow & State** — How data moves through the system (traced from actual code, not guessed)427. **Failure Modes & Error Handling** — What breaks, how errors propagate, recovery patterns438. **Performance Characteristics** — Bottlenecks, scaling limits, hot paths449. **Security Model** — Auth, authorization, trust boundaries, data sensitivity4510. **Testing Strategy** — What's tested, what isn't, testing philosophy4611. **Operational Concerns** — Deployment, monitoring, feature flags, configuration4712. **Known Technical Debt** — Honest assessment of shortcuts and their risks4849### Rules50- Every claim backed by `(file_path:line_number)` citation51- Minimum 3 Mermaid diagrams (architecture, data flow, dependency graph)52- All Mermaid diagrams use dark-mode colors (see wiki-vitepress skill)53- Focus on WHY decisions were made, not just WHAT exists5455## Guide 2: Zero-to-Hero Contributor Guide5657**Audience**: New contributors who need step-by-step practical guidance.5859### Required Sections60611. **What This Project Does** — 2-3 sentence elevator pitch622. **Prerequisites** — Tools, versions, accounts needed633. **Environment Setup** — Step-by-step with exact commands, expected output at each step644. **Project Structure** — Annotated directory tree (what lives where and why)655. **Your First Task** — End-to-end walkthrough of adding a simple feature666. **Development Workflow** — Branch strategy, commit conventions, PR process677. **Running Tests** — How to run tests, what to test, how to add a test688. **Debugging Guide** — Common issues and how to diagnose them699. **Key Concepts** — Domain-specific terminology explained with code examples7010. **Code Patterns** — "If you want to add X, follow this pattern" templates7111. **Common Pitfalls** — Mistakes every new contributor makes and how to avoid them7212. **Where to Get Help** — Communication channels, documentation, key contacts7313. **Glossary** — Terms used in the codebase that aren't obvious7414. **Quick Reference Card** — Cheat sheet of most-used commands and patterns7576### Rules77- All code examples in the detected primary language78- Every command must be copy-pasteable79- Include expected output for verification steps80- Use Mermaid for workflow diagrams (dark-mode colors)81- Ground all claims in actual code — cite `(file_path:line_number)`8283## When to Use84This skill is applicable to execute the workflow or actions described in the overview.