onboard

Generates a role-specific onboarding document summarizing project architecture, conventions, and current priorities.

Updated Aug 2, 2026
One-click install
npx skills add https://github.com/claretagrapelike32/codex-ai-game-studio --skill onboard-claretagrapelike32
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/claretagrapelike32/codex-ai-game-studio/tree/main/plugins/ai-game-studio/skills/onboard
Command: npx skills add https://github.com/claretagrapelike32/codex-ai-game-studio --skill onboard-claretagrapelike32

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? New contributors and agents joining a game project lack context about its architecture, conventions, and current work, forcing them to spend hours reading scattered files before becoming productive. ## Core Features & Use Cases - Context Scanning: Reads AGENTS.md, agent role definitions, and role-relevant directories (src/, design/, tests/, production/) plus recent git history to build an accurate picture of project state. - Structured Onboarding Document: Produces a Markdown document covering project summary, role responsibilities, key directories and files, conventions, sprint context, dependencies, pitfalls, and suggested first tasks. - Persistent Output: Saves the document to production/onboarding/onboard-[role]-[date].md after user confirmation. - Use Case: A new QA engineer joins a game studio project; run this Skill to generate a document summarizing existing test coverage, current sprint goals, and the first tasks they should pick up. ## Quick Start Use the onboard skill to generate an onboarding document for a new programmer joining this project.

Frequently Asked Questions about onboard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create an onboarding document for a new project contributor?

Invoke the onboard skill with the contributor's role, and it scans AGENTS.md, role definitions, and relevant directories to generate a structured Markdown document. The output covers architecture, conventions, current sprint context, and suggested first tasks.

What project files does the onboarding skill read?

It reads AGENTS.md for project standards, agent definitions from .codex/agents/ for the specified role, and role-relevant directories such as src/, design/, tests/, or production/. It also reviews recent git history to capture current momentum.

Can I generate onboarding docs for different roles like QA or design?

Yes, the skill adapts its scan per role: programmers get src/ architecture, designers get design/ documents, narrative roles get design/narrative/, QA gets tests/ coverage, and production roles get sprint and milestone files.

Where is the generated onboarding document saved?

After presenting the document, the skill asks for confirmation and writes it to production/onboarding/onboard-[role]-[date].md, creating the directory if it does not exist.

Does the onboarding skill work without a git repository?

Yes, git history is optional. The skill reads recent changes via git log if available, but it can still generate the document from AGENTS.md, agent definitions, and directory scans alone.