skills.rest
XGanQAQ
XGanQAQCOMMUNITY
Explore all skills by this author →
GitHub

onboard

Generate a markdown onboarding document from project state and conventions.

1|Updated May 5, 2026
Search Tags:#onboarding#project context#role-based#repository scanning#architecture summary#contributor ramp-up
One-click install
npx skills add https://github.com/XGanQAQ/Unity-Claude-Code-Game-Studios --skill onboard-xganqaq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/XGanQAQ/Unity-Claude-Code-Game-Studios/tree/main/.claude/skills/onboard
Command: npx skills add https://github.com/XGanQAQ/Unity-Claude-Code-Game-Studios --skill onboard-xganqaq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It eliminates the confusion and wasted time new contributors face when joining a complex project by turning the current studio state, conventions, and priorities into a ready-to-use onboarding brief.

Core Features & Use Cases

  • Role/Area-aware context: Builds the onboarding content for a specified role or project area by pulling the relevant agent definition when provided.
  • Targeted repository scanning: Scans the most relevant directories (e.g., src/, design/, design/narrative/, tests/, production/) to reflect what is actually present today.
  • Actionable next steps: Produces a structured document that includes first tasks, key dependencies, pitfalls, and questions to ask to accelerate ramp-up.

Quick Start

Run the onboard skill with role=programmer to generate a new contributor onboarding document tailored to the current codebase and programming conventions.

Frequently Asked Questions about onboard

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

FAQPage Schema
How do I generate role-based onboarding documents for new contributors?▼

Role-based onboarding is generated by scanning repository sections, reading CLAUDE.md, and summarizing project architecture to reflect a specified role's priorities. The final markdown onboarding file is written under production/onboarding after user confirmation.

How does repository scanning work for contributor ramp-up in multi-agent game development?▼

Repository scanning for contributor ramp-up works by targeting relevant directories like src/, design/, and tests/ to reflect the current project state. It optionally inspects recent git changes to ensure the onboarding context aligns with the current sprint.

Can I customize onboarding context for different project areas like narrative or programming?▼

Onboarding context is customized for areas like narrative or programming by pulling the relevant agent definition when provided. This ensures the generated architecture summary and conventions reflect the specified role or project area.

What is the best way to summarize project architecture and conventions for a new team member?▼

The best way to summarize project architecture is to use a tool that reads existing agent definitions and scans relevant directories. This produces a structured document with first tasks, key dependencies, pitfalls, and questions to accelerate ramp-up.

Does project context onboarding work with existing markdown files like CLAUDE.md?▼

Project context onboarding works directly with existing markdown files like CLAUDE.md by reading them to extract current studio state and conventions. This ensures the generated brief accurately reflects the active multi-agent game development workflow.

Related Skills

Explore More Software Engineering Skills→
polsegupolsegu

onboard

Generate role-focused onboarding documents from project documentation and directories.

Community
Intermediate
MichaelSolatiMichaelSolati

onboard

Generates onboarding documents from scanned Rust project files and git history.

Community
Intermediate
gupsammygupsammy
270

update-readme

Synchronize README.md with codebase state, git history, and changelog.

Community
Advanced
scomofoscomofo

onboard

Generates a role-specific onboarding document from AGENTS.md and scanned directories for Godot/production workflows.

Community
Intermediate