onboard

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

Updated Apr 4, 2026
One-click install
npx skills add https://github.com/WindXRan/y3td --skill onboard-windxran
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/WindXRan/y3td/tree/main/.claude/skills/onboard
Command: npx skills add https://github.com/WindXRan/y3td --skill onboard-windxran

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Onboarding new contributors or agents is slow and error-prone because they lack a consolidated, role-aware snapshot of the repository’s architecture, standards, current state, and near-term priorities.

Core Features & Use Cases

  • Role/Area-specific onboarding generation: Produces a structured onboarding document tailored to a specified role or project area (e.g., programmer, designer, QA, production).
  • Targeted repository scanning: Reads CLAUDE.md and then scans the most relevant directories (like src/, design/, design/narrative/, tests/, or production/) plus recent changes when available.
  • Actionable next steps: Includes common pitfalls, key dependencies, suggested first tasks, and questions to ask so the new person can become productive quickly.

Quick Start

Ask the AI to generate onboarding for your role by running: onboard with argument "programmer".

Frequently Asked Questions about onboard

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

FAQPage Schema
How do I generate a role-specific onboarding document for a new contributor?

To generate a role-specific onboarding document, the tool scans repository directories and consolidates project context, architecture, and standards into a markdown file. It targets specific roles like programmer or designer to accelerate contributor enablement.

What is repository scanning for contributor onboarding?

Repository scanning for onboarding involves reading context files like CLAUDE.md and analyzing directories to synthesize architecture and priorities. This process creates a consolidated snapshot to help new contributors understand the codebase quickly.

Can I use this to create onboarding docs for non-programming roles like QA or design?

Yes, you can create onboarding docs for non-programming roles like QA, design, and production. The tool generates tailored guidance by scanning role-specific directories such as design/ or tests/ alongside standard project context files.

How do I start onboarding a new agent with this repository scanning tool?

Start onboarding a new agent by invoking the command with a specified role argument like programmer. The tool will read project standards, scan the relevant codebase areas, and write a markdown document to a production onboarding path after your confirmation.

What context does an onboarding doc include to help a new developer become productive?

An onboarding doc includes common pitfalls, key dependencies, suggested first tasks, and questions to ask. By synthesizing recent repository changes and architecture standards, it provides actionable next steps so a new developer can become productive quickly.

Does this onboarding generator require a CLAUDE.md file to work?

Yes, the onboarding generator requires a CLAUDE.md file to establish baseline project context and standards. It reads this file first to satisfy onboarding requirements before scanning directories and writing the final markdown document.