skills.rest
FrancisVarga
FrancisVargaCOMMUNITY
Explore all skills by this author →
GitHub

onboard

Generate role-specific onboarding documents from repository architecture and conventions.

Updated May 13, 2026
Search Tags:#documentation#onboarding#project context#team coordination#role summary#workflow scanning#contributor support
One-click install
npx skills add https://github.com/FrancisVarga/the-dream-machine --skill onboard-francisvarga
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/FrancisVarga/the-dream-machine/tree/main/.claude/skills/onboard
Command: npx skills add https://github.com/FrancisVarga/the-dream-machine --skill onboard-francisvarga

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Onboarding new contributors or agents often fails because they receive no clear, role-targeted summary of the project’s current state, conventions, architecture, and immediate priorities.

Core Features & Use Cases

  • Contextual onboarding generation: Produces a structured onboarding document tailored to a specified role or area, based on the repository’s existing standards and definitions.
  • Relevant-area scanning: Reads the appropriate sections of the repo (e.g., src/, design/, design/narrative/, tests/, production/) to summarize what exists and what’s next.
  • Actionable next steps: Includes dependencies, common pitfalls, first tasks, and questions to ask so the newcomer can become productive quickly.

Quick Start

Ask the skill to create onboarding for the "QA" role by running: onboard QA.

Frequently Asked Questions about onboard

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

FAQPage Schema
How do I generate role-specific onboarding documentation for new project contributors?▼

Role-specific onboarding documentation is generated by reading CLAUDE.md and agent definitions, scanning relevant repository directories, and summarizing architecture, conventions, and priorities into a markdown file.

What is the best way to create an onboarding summary for a new QA contributor?▼

Creating an onboarding summary for a QA contributor involves running the onboard command with the QA role, which scans the tests directory and project conventions to produce a targeted markdown onboarding document.

Can I generate onboarding documents for non-engineering roles like design and narrative?▼

Yes, onboarding documents can be generated for non-engineering roles by scanning appropriate directories like design and narrative, summarizing relevant project context and conventions for those specific areas.

How does repository scanning work when creating project context for new team members?▼

Repository scanning works by reading existing standards in CLAUDE.md, scanning relevant sections like src or tests, and optionally incorporating recent git changes to summarize current architecture and immediate priorities.

Does generating contributor onboarding require any specific project files or dependencies?▼

Generating contributor onboarding requires reading the CLAUDE.md file and the relevant agent definition to accurately summarize project architecture, conventions, and priorities for the specified role.

What actionable next steps are included in a generated onboarding document for new agents?▼

Generated onboarding documents include actionable next steps such as dependencies, common pitfalls, first tasks, and questions to ask, ensuring new agents become productive quickly within the active studio workflow.

Related Skills

Explore More Content & Communication Skills→
WindXRanWindXRan

onboard

Generate a role-specific onboarding markdown document from repository context.

Community
Intermediate
scomofoscomofo

onboard

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

Community
Intermediate
heyAyushhheyAyushh
3

init

Generate AGENTS.md and CLAUDE.md documentation from repository guidance files.

Community
Intermediate
MichaelSolatiMichaelSolati

onboard

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

Community
Intermediate