Agent skill

Contributor Onboarding Doc

by Donchitos in Donchitos/Claude-Code-Game-Studios

Writes an onboarding document for a new contributor or agent, covering project state, conventions and priorities relevant to a chosen role.

MITAuto-check passedDevelopment

Install Contributor Onboarding Doc

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

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install Donchitos/Claude-Code-Game-Studios onboard --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/Donchitos/Claude-Code-Game-Studios.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/onboard .claude/skills/onboard && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
onboard
GitHub stars
26k
Token cost
~1.4k tokens
SKILL.md length
548 words
Files
1
Skills in repo
73
Repo updated
First seen
Licence
MIT

At a glance

Writes an onboarding document for a new contributor or agent, covering project state, conventions and priorities relevant to a chosen role.

  • Works in 5 steps: Load Project Context → Scan Relevant Area → Generate Onboarding Document → …
  • Bringing a new programmer or artist up to speed on a game project's current state
  • SKILL.md covers Insufficient input — check…, Phase 1: Load Project Context, Phase 2: Scan Relevant Area and Phase 3: Generate Onboarding…, plus 2 more sections
  • Calls bash

What it does

The skill assembles a role-specific onboarding document. It reads `CLAUDE.md` for the project overview and standards and, when you name a role, the matching agent definition under `.claude/agents/`. Both ship with the framework, so if either is missing the skill reports a broken install instead of inventing content.

It then scans the part of the project that matters to that role and writes the document. Before producing anything it lists the inputs it needs, marks each as found or absent and reports sections without data as NOT ASSESSED rather than guessing. A config helper supplies the automation mode, which sets how often it asks before writing.

When your agent uses it

  • Bringing a new programmer or artist up to speed on a game project's current state
  • Briefing an agent for a specific role on project conventions
  • Writing a handover document when a contributor joins mid-project

Example prompts

  • “Create an onboarding doc for a new gameplay programmer joining the project.”
  • “Onboard the audio director agent with the conventions and current priorities.”
  • “Write a role-based onboarding brief for a new level designer.”

Requirements

  • `CLAUDE.md` and `.claude/agents/` from the Claude Code Game Studios install
  • Pre-approved tools (allowed-tools): Read, Glob, Grep, Write, Bash(bash "*/.claude/skills/onboard/../../hooks/yaml-helper.sh" resolve_config *)

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. Load Project Context
  2. Scan Relevant Area
  3. Generate Onboarding Document
  4. Save Document
  5. Next Steps

What it can do on your machine

Read from SKILL.md and the folder at commit b21fa0f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Glob
    • Grep
    • Write
    • Bash(bash "*/.claude/skills/onboard/../../hooks/yaml-helper.sh" resolve_config *)

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • bash

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Contributor Onboarding Doc loads about 1.4k tokens when it runs. Until then it costs about 32 tokens; SKILL.md has 548 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~32
When it runs · the whole SKILL.md, loaded when a task matches
~1.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from Donchitos/Claude-Code-Game-Studios at commit b21fa0f, republished under its MIT licence (© Donchitos). 548 words, ~1,370 tokens.

Download SKILL.mdSave it as .claude/skills/onboard/SKILL.md (or your agent's skills folder).
name
onboard
description
Onboarding doc for a new contributor or agent — project state, conventions, priorities relevant to the specified role.
allowed-tools
Read, Glob, Grep, Write, Bash(bash "*/.claude/skills/onboard/../../hooks/yaml-helper.sh" resolve_config *)
argument-hint
[role|area]
user-invocable
true
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).

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 and has been observed in practice: report templates whose verdict enum had no "could not run" state produced false clean passes — an asset audit returning COMPLIANT on a project with no assets and no standards, and 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.


Show full SKILL.md (205 more words)Show less

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. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/onboard of Donchitos/Claude-Code-Game-Studios.

Open the folder on GitHubat commit b21fa0f

Compare with similar skills

Contributor Onboarding Doc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Contributor Onboarding Doc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Contributor Onboarding Doc this skillDonchitos/Claude-Code-Game-Studios26k—~1.4kAutomated safety check: PassMIT
Project Onboarding Guide from Knowledge GraphEgonex-AI/Understand-Anything86k—~1.2kAutomated safety check: PassMIT
Deepwiki Rssopaco/deepwiki-rs3.1k—~748Automated safety check: PassMIT
Acquire Codebase Knowledgegithub/awesome-copilot40k1 repos~2.3kAutomated safety check: PassMIT
Codex Proxy RS Development Guidezyycn/codex-proxy-rs750—~618Automated safety check: PassApache-2.0
Evidence-Grounded ExplainerEveryInc/compound-engineering-plugin25k—~2.1kAutomated safety check: PassMIT

Similar skills

  • Writes an onboarding guide for new team members from a project's existing knowledge graph, after checking that the graph still matches the current commit.

    86k GitHub stars~1.2k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Deepwiki Rs

    sopaco/deepwiki-rs

    AI-powered Rust documentation generation engine for comprehensive codebase analysis, C4 architecture diagrams, and automated technical documentation.

    3.1k GitHub stars~748 tokensUpdated 24 days ago
    DevelopmentAuto-check passed
  • Acquire Codebase Knowledge

    github/awesome-copilot

    Official

    Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.

    40k GitHub starsUsed in 1 repo~2.3k tokens
    DevelopmentAuto-check passed
  • Routes development, troubleshooting, review and documentation tasks on the Codex Proxy RS repository to the right section of its docs, instead of loading the whole architecture or contributing guide.

    750 GitHub stars~618 tokensUpdated today
    DevelopmentAuto-check passed
  • Evidence-Grounded Explainer

    EveryInc/compound-engineering-plugin

    Produces an evidence-backed explanation of how and why something has its current shape, or what happened over a stretch of work, tuned to its intended reader.

    25k GitHub stars~2.1k tokensUpdated today
    DevelopmentAuto-check passed
  • Spec Miner

    Jeffallan/claude-skills

    Reads an undocumented codebase and writes up what it does: architecture, data flows, observed behavior as EARS requirements, and open questions to confirm.

    12k GitHub starsUsed in 1 repo~1.2k tokens
    DevelopmentAuto-check passed

More from Donchitos/Claude-Code-Game-Studios

All 73 skills in this repo
  • Game Asset Audit

    Donchitos/Claude-Code-Game-Studios

    Audits game assets against naming conventions, file size budgets and format standards, and finds orphaned assets and missing references.

    26k GitHub stars~2k tokensUpdated 9 days ago
    Auto-check passed
  • Game Asset Spec Writer

    Donchitos/Claude-Code-Game-Studios

    Writes per-asset visual specs and AI image-generation prompts for a game's characters, enemies and screens, driven by the GDD, art bible and an entity inventory.

    26k GitHub stars~5k tokensUpdated 9 days ago
    Auto-check passed
  • Game Balance Check

    Donchitos/Claude-Code-Game-Studios

    Checks game data and formulas for balance outliers, broken progression, degenerate strategies and economy problems, and answers 'could not run' when the data is missing.

    26k GitHub stars~2.2k tokensUpdated 9 days ago
    Auto-check passed
  • Structured Bug Reports

    Donchitos/Claude-Code-Game-Studios

    Turns a description into a structured bug report, or scans code for likely bugs, then verifies and closes reports through four modes.

    26k GitHub stars~2.5k tokensUpdated 9 days ago
    Auto-check: notes
  • Bug Triage

    Donchitos/Claude-Code-Game-Studios

    Reviews the open bug backlog, separates severity from priority, assigns fixes to sprints and reports systemic trends, writing a dated triage file.

    26k GitHub stars~2.3k tokensUpdated 9 days ago
    Auto-check passed
  • Changelog Generator for Games

    Donchitos/Claude-Code-Game-Studios

    Generates an internal or player-facing changelog from git commits and sprint data, filtering out framework maintenance commits so that only work on the game itself reaches release copy.

    26k GitHub stars~2.5k tokensUpdated 9 days ago
    Auto-check: notes

Questions about Contributor Onboarding Doc

What does Contributor Onboarding Doc do?

Writes an onboarding document for a new contributor or agent, covering project state, conventions and priorities relevant to a chosen role. The skill assembles a role-specific onboarding document.claude/agents/`.

When should I use Contributor Onboarding Doc?

Contributor Onboarding Doc fits situations like: bringing a new programmer or artist up to speed on a game project's current state; briefing an agent for a specific role on project conventions; writing a handover document when a contributor joins mid-project.

How do I install Contributor Onboarding Doc in Claude Code?

Run `npx skills add Donchitos/Claude-Code-Game-Studios --skill onboard -a claude-code`. Or copy the skill folder (.claude/skills/onboard in Donchitos/Claude-Code-Game-Studios) into .claude/skills/onboard in your project. Claude Code loads it when a task matches its description.

How do I install Contributor Onboarding Doc in Codex?

Run `npx skills add Donchitos/Claude-Code-Game-Studios --skill onboard -a codex`. Or copy the skill folder (.claude/skills/onboard in Donchitos/Claude-Code-Game-Studios) into .agents/skills/onboard in your project. Codex loads it when a task matches its description.

Can I use Contributor Onboarding Doc in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add Donchitos/Claude-Code-Game-Studios --skill onboard -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/onboard, .gemini/skills/onboard, .github/skills/onboard and .opencode/skills/onboard in your project.

What does Contributor Onboarding Doc need to run?

Going by SKILL.md and its folder, Contributor Onboarding Doc needs the command-line tools its instructions call (bash). Our summary lists: `CLAUDE.md` and `.claude/agents/` from the Claude Code Game Studios install. Its frontmatter pre-approves these tools: Read, Glob, Grep, Write, Bash(bash "*/.claude/skills/onboard/../../hooks/yaml-helper.sh" resolve_config *).

Does Contributor Onboarding Doc access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Contributor Onboarding Doc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Contributor Onboarding Doc use?

Contributor Onboarding Doc is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Contributor Onboarding Doc use?

About 1.4k tokens (SKILL.md is roughly 5.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Contributor Onboarding Doc?

Skills that share tags, products or a category with Contributor Onboarding Doc: Project Onboarding Guide from Knowledge Graph (Egonex-AI/Understand-Anything, 86k stars), Deepwiki Rs (sopaco/deepwiki-rs, 3.1k stars), Acquire Codebase Knowledge (github/awesome-copilot, 40k stars) and Codex Proxy RS Development Guide (zyycn/codex-proxy-rs, 750 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Contributor Onboarding Doc?

Donchitos (a GitHub user) maintains it in Donchitos/Claude-Code-Game-Studios, which has 25,871 GitHub stars. The repository holds 73 skills in this directory. The repository was last updated on September 29, 2026.

Source: Donchitos/Claude-Code-Game-Studios on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.