Skip to content

Project Onboarding Guide

Generates a role-specific onboarding doc for a game project contributor or agent

Stars
32,965
Licence
MIT
Files
1 file

What it does

When invoked with a role or area (such as programmer, designer, narrative, QA, or production), the agent reads the project's CLAUDE.md, the matching agent definition, and the relevant project folders, then writes a structured onboarding document covering the project summary, the role's responsibilities, key directories and files, conventions, current state, and first tasks. It can also save that document to a production/onboarding folder, but only after asking permission. If required inputs are missing, it reports that it could not run rather than guessing.

Great for

  • A new contributor joining a game project who needs a structured orientation for their role
  • A team lead who wants a repeatable onboarding document generated for a new agent or person
  • Someone working in the Claude Code Game Studios framework who needs to understand the existing design, code, and sprint layout

Skip it if

  • Projects that do not use the Claude Code Game Studios folder layout (CLAUDE.md, .claude/agents, design/, production/); the output will largely report missing pieces and be of little use
  • Situations needing verified current facts: the document is generated from files and recent git history, so it can be out of date or incomplete if those are stale

Try asking

  • “/onboard programmer”
  • “/onboard designer”
  • “/onboard qa”
  • “/onboard”
Step-by-step guide: how to use Project Onboarding GuideInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    onboard.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip onboard.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip onboard.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Pass a specific role or area (for example /onboard programmer) so the scan focuses on the right folders; with no argument it produces only a general orientation
  • Expect the skill to ask before writing any file, and review the generated document for accuracy against the current code before sharing it
  • If the report says NOT ASSESSED, add the missing directories or documents first (for example run /test-setup for tests) and run it again

What's inside

  • SKILL.md

Redistributed unmodified from Donchitos/Claude-Code-Game-Studios under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.