wiki-onboarding_skill

Overview

This skill generates four audience-tailored onboarding guides in an onboarding/ folder — Contributor, Staff Engineer, Executive, and Product Manager — to help new team members get productive with a codebase. It first resolves the source repository context (remote URL and default branch) and then produces linked, evidence-backed guides that reference actual files and lines in the repository.

How this skill works

The skill inspects the repository to detect the primary language (by scanning files like go.mod, package.json, pyproject.toml, etc.) and validates the source context by checking git remotes and the current branch. It then generates the onboarding/ folder with index.md plus four guides, embedding linked citations (remote or local) and mermaid diagrams where appropriate while honoring audience constraints (no code in Executive/PM guides).

When to use it

• When you need ready-to-use onboarding documentation for a codebase.
• Before adding new engineers, product managers, or executives to a project.
• When you want structured, evidence-backed guides that cite actual source files.
• When running the /deep-wiki:onboard command or similar automation.

Best practices

• Resolve repo context first: run git remote get-url origin and git rev-parse --abbrev-ref HEAD before generating guides.
• Provide a repository URL if available so the skill can create linked citations; otherwise accept local citations.
• Confirm the detected primary language (e.g., Go via go.mod) so code examples match the repo.
• Review and edit generated guides to add product-specific tone, missing diagrams, or policies.
• Validate that file paths, class/method names, and mermaid diagrams render correctly after generation.

Example use cases

• Create onboarding for a Go microservice repo before a new contributor starts their first task.
• Prepare an executive summary and risk table for a VP before a roadmap review.
• Produce a PM-facing feature capability map and user journey for planning sessions.
• Provide a staff engineer with architecture diagrams, decision logs, and known technical debt for a system redesign.