Skip to main content
skill CX Codex

onboard · donchitos — Claude Code skill: what it does, how to install

Builds an onboarding document for a contributor or agent, covering project state, conventions, structure, and first tasks for a selected role.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add Donchitos/Claude-Code-Game-Studios --skill onboard -a claude-code
Open on GitHub

What onboard does

The skill reads CLAUDE.md, the matching role definition in .claude/agents/, and files from the selected area. Programmers get a code-root scan, designers get design/, narrative work uses design/narrative/, QA uses tests/, and production uses production/. It also checks recent changes with git log when that command is available.

The generated document covers the project summary, architecture, key directories and files, current conventions, area status, dependencies, common pitfalls, and first tasks. Pass a role or area such as programmer; with no argument, it creates a general orientation from top-level directories and production/session-state/active.md when present.

Automation mode comes from the project configuration. Before writing to production/onboarding/onboard-[role]-[date].md, the skill asks for permission. If CLAUDE.md or .claude/agents/ is missing, it reports an installation problem. Check those files before relying on the resulting report.

What it helps with

  • create an onboarding document for a new role
  • inspect the current state of a project area
  • locate key files and project conventions
  • outline first tasks for a contributor
  • summarize the current sprint context

Example prompts for the agent

  • Run /onboard programmer and prepare an onboarding document for the code and architecture.
  • Use /onboard designer to inspect design/ and summarize the existing materials.
  • Run /onboard for a general project orientation, including top-level directories and production/session-state/active.md.

How to install onboard

1Skills CLI (Vercel)

npx skills add Donchitos/Claude-Code-Game-Studios --skill onboard -a claude-code

2Manually: put the files in place

~/.claude/skills/onboard/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/onboard/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about onboard

How do I install onboard in Claude Code?

Run npx skills add Donchitos/Claude-Code-Game-Studios --skill onboard -a claude-code, then run npx skills add Donchitos/Claude-Code-Game-Studios --skill onboard -a claude-code again. After installation, the file is at ~/.claude/skills/onboard/SKILL.md. These are all steps for this method, in order.

What does the onboard skill do?

It creates an onboarding document for a role or area by loading project context, scanning relevant directories, checking recent changes, and listing first tasks. It asks before saving the document under production/onboarding/.

What happens when required project files are missing?

The skill checks the materials needed for each report section first. If CLAUDE.md or a role definition in .claude/agents/ is missing, it reports an installation problem instead of filling the section with guesses.

Source text

SKILL.md · MIT
---
name: onboard
description: "Onboarding doc for a new contributor or agent — project state, conventions, priorities relevant to the specified role."
argument-hint: "[role|area]"
user-invocable: true
allowed-tools: Read, Glob, Grep, Write, Bash(bash "*/.claude/skills/onboard/../../hooks/yaml-helper.sh" resolve_config *)
model: haiku
---

!`bash "${CLAUDE_SKILL_DIR}/../../hooks/yaml-helper.sh" resolve_config --keys automation`

**Automation mode**: Resolve `modes.automation` (`project.local.yaml` →
`project.yaml` → default `collaborative`). Every `AskUserQuestion` call and
every file write follows `.claude/docs/automation-modes.md`
(collaborative asks always · guided major-only · autonomous logs and proceeds;
`automation_always_ask` categories always prompt).

# Onboard

## Insufficient input — check this before producing any report

**If the inputs this skill needs do not exist, the answer is "could not run" —
not a filled-in report.** Check first, and stop if the check fails.

1. List the inputs this skill reads (data files, prior reports, profiler output,
   test results, registries, source code).
2. For each, record `FOUND` or `ABSENT` — not "assumed present".
3. If any input required for a section is ABSENT, that section is
   **`NOT ASSESSED — NO DATA`**. Do not estimate it, do not infer it from an
   adjacent artifact, and do not leave a mandated cell to be filled by whoever
   reads the template next.
4. If **every** required input is ABSENT, stop and report
   **`NOT ASSESSED — NO DATA`** as the whole verdict, naming what was missing and
   which skill produces it.

**A verdict of `NOT ASSESSED` is a success.** It is the correct, useful answer to
"what does the data say?" when there is no data. The failure mode this prevents is
specific: a report whose verdict enum has no "could not run" state produces
**false clean passes** — an asset audit returning COMPLIANT on a project with no
assets and no standards, or a performance profile reporting ">99% headroom against
a 16.67ms budget" with zero profiler data and no budget ever set.

**Absence of evidence is never evidence of absence.** A scan that finds no
matches because there are no files to scan has not verified anything. Say which of
the two happened — a reader cannot tell from a green result.

---

## Phase 1: Load Project Context

Read CLAUDE.md for project overview and standards.

Read the relevant agent definition from `.claude/agents/` if a specific role is specified.

`CLAUDE.md` and `.claude/agents/` ship with the framework — no skill creates them. If either is missing, report it as missing from the install.

---

## Phase 2: Scan Relevant Area

- For programmers: scan the code root (resolve per `.claude/docs/code-root-resolution.md`) for architecture, patterns, key files. An unresolved root means the scan did not run: the sections it feeds read `NOT ASSESSED — code root unresolved`, never a guess at `src/`
- For designers: scan `design/` for existing design documents
- For narrative: scan `design/narrative/` for world-building and story docs
- For QA: scan `tests/` for existing test coverage (`/test-setup` creates it)
- For production: scan `production/` for current sprint and milestone
- **No role or area given**: a general orientation — list the top level of `design/`,
  `docs/architecture/`, `production/` and the code root, read
  `production/session-state/active.md` if it exists, and say that a role would
  focus the next pass (e.g. `/onboard programmer`)

Read recent changes (git log if available) to understand current momentum.

---

## Phase 3: Generate Onboarding Document

```markdown
# Onboarding: [Role/Area]

## Project Summary
[2-3 sentence summary of what this game is and its current state]

## Your Role
[What this role does on this project, key responsibilities, who you report to]

## Project Architecture
[Relevant architectural overview for this role]

### Key Directories
| Directory | Contents | Your Interaction |
|-----------|----------|-----------------|

### Key Files
| File | Purpose | Read Priority |
|------|---------|--------------|

## Current Standards and Conventions
[Summary of conventions relevant to this role from CLAUDE.md and agent definition]

## Current State of Your Area
[What has been built, what is in progress, what is planned next. Name what
Phase 2 found by path — for a designer, each existing GDD and design doc — or
say it found none]

## Current Sprint Context
[What the team is working on now and what is expected of this role]

## Key Dependencies
[What other roles/systems this role interacts with most]

## Common Pitfalls
[Things that trip up new contributors in this area]

## First Tasks
[Suggested first tasks to get oriented and productive]

1. [Read these documents first]
2. [Review this code/content]
3. [Start with this small task]

## Questions to Ask
[Questions the new contributor should ask to get fully oriented]
```

---

## Phase 4: Save Document

Present the onboarding document to the user.

Ask: "May I write this to `production/onboarding/onboard-[role]-[date].md`?"

If yes, write the file, creating the directory if needed.

---

## Phase 5: Next Steps

Verdict: **COMPLETE** — onboarding document generated.

- Share the onboarding doc with the new contributor before their first session.
- Run `/sprint-status` to show the new contributor current progress.
- Run `/help` if the contributor needs guidance on what to work on next.

© Donchitos · MIT · Donchitos/Claude-Code-Game-Studios

Similar skills

All skills for Agent setup: memory, context, orchestration →

onboard by other authors comes first.

onboard Alireza Rezvani A 12-question founder interview that populates ~/.claude/company-context.md with business facts, runway, and goals for virtual executive agents. 361installs onboard aladicf Designs a product's first run: what a new user sees, in what order, and how they reach their first win. CX Codex +1 521installs openspec-onboard openspec Guides a first OpenSpec workflow on a real codebase task, from choosing the work to archiving the finished change. CX Codex +1 4,000installs understand-onboard Egonex-AI Generates a structured project onboarding guide for new teammates using an existing knowledge graph. Useful for introducing developers to unfamiliar repositories. CX Codex +1 3,700installs groove-utilities-onboard andreadellacorte Writes a GROOVE.md at the project root so a new contributor knows which commands to run and where logs live. Handy when someone joins a groove project. CX Codex +1 505installs ue-project-context quodsoler Builds .agents/ue-project-context.md, the file other UE skills read to learn your engine version, modules, plugins and conventions. CX Codex +1 1,300installs ue-ai-navigation quodsoler A skill for writing Unreal Engine 5.8 C++ AI: controllers, behavior trees, perception, navmesh and EQS. Useful when the agent writes AI code and mixes up APIs. CX Codex +1 1,100installs use-template OpusGameLabs Copies a ready game template from the gallery into a new project. You get runnable code right away, no AI pipeline involved. CX Codex +1 838installs

From the same set72

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor