onboard

Generate role-specific Markdown onboarding documents from project state and conventions.

Updated Dec 22, 2024
One-click install
npx skills add https://github.com/imgamer/AILearn --skill onboard-imgamer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/imgamer/AILearn/tree/main/game-studios/Claude-Code-Game-Studios-e375f/.claude/skills/onboard
Command: npx skills add https://github.com/imgamer/AILearn --skill onboard-imgamer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of onboarding new contributors or agents by quickly producing a clear, role-focused document that summarizes the project, where to look, and what to do first.

Core Features & Use Cases

  • Context-driven onboarding generation: Reads project overview standards and optional role-specific agent definitions to tailor the onboarding output.
  • Relevant-area scanning: Locates and summarizes key directories and files based on the specified role or area (e.g., programmers scan src/, QA scans tests/).
  • Actionable next steps: Produces first tasks, pitfalls, and guiding questions, then optionally writes the onboarding doc to the production onboarding path for reuse.

Quick Start

Use the onboard skill to create onboarding for a new programmer by providing the role as input to generate a role-specific document.

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 documentation for new project contributors?

Role-based onboarding documentation is generated by scanning project directories and conventions to produce a focused Markdown summary. It reads project standards and optional role definitions to tailor the output for specific contributor areas like programming or QA.

What is the best way to onboard a new agent into an existing project architecture?

Onboarding a new agent involves summarizing project state, architecture, and current priorities into a structured document. The process scans relevant directories based on the agent's specified role and incorporates recent change context to provide actionable next steps.

Can I create separate onboarding documents for different roles like QA and design?

Yes, separate onboarding documents can be created for QA, design, programming, narrative, and production contexts. The generation process locates and summarizes key directories specific to each role, such as scanning tests for QA or src for programmers.

How does prompt-driven reporting work for contributor enablement?

Prompt-driven contributor enablement works by reading project overview files like CLAUDE.md and role-specific definitions to generate structured Markdown. It produces first tasks, pitfalls, and guiding questions tailored to the specified role.

Do I need specific project files to generate contextual onboarding documentation?

You need a CLAUDE.md file to provide project overview standards for the onboarding generation. Optionally, role definitions located under the .claude/agents/ directory can be read to further tailor the generated onboarding output.

Where does the generated role-based onboarding document get saved?

The generated role-based onboarding document can optionally be written directly to a production onboarding path. This allows the structured Markdown output to be reused for future contributors entering the project.