← ClaudeAtlas

create-onboarding-guidelisted

Generate a self-contained HTML onboarding tour of a repository — architecture diagram, directory map, key flow walkthroughs, and a recommended reading order — for new team members. Use when the user wants onboarding material, asks for a codebase overview/architecture tour, or wants to explain a repo to someone new.
atman-33/workhub · ★ 1 · Web & Frontend · score 77
Install: claude install-skill atman-33/workhub
# Create Onboarding Guide Produce one self-contained HTML file that takes a newcomer from zero to "I know where things live and how the main flows run" in one sitting. ## 1. Resolve the output directory Same per-installer configuration as this plugin's other guide skills: 1. `${CLAUDE_PLUGIN_ROOT}/config.json` → `outputDir` (shared across this plugin's skills) 2. `config.json` next to this SKILL.md → `outputDir` (skill-level override) 3. Neither exists → read [config.example.json](config.example.json) for the shape, ask the user for a real absolute path, then write the skill-level `config.json` (git-ignored). Honor `openAfterGenerate` (default `true`). ## 2. Confirm the target Confirm which repository (and, for a monorepo, which package/area) the guide covers, and who it's for (new engineer on the team vs. external contributor) — that decides how much project-specific context to assume. Default: the whole current repo, for a new team engineer. ## 3. Explore the codebase — the guide is only as true as this step - Map the layout: top-level directories, build/config files, README/docs. - Identify the architecture: layers/modules and the dependencies between them, traced from real imports/references (Grep), not directory names alone. - Trace 2–3 **key flows** end-to-end (e.g. a request from route → handler → service → persistence; app startup; the primary user action). Record actual file:line hops. - Note conventions a newcomer must know: naming patterns, whe