onboard

Name: onboard
Availability: InStock
Author: easonlao

Generate a structured Markdown onboarding document from project files and conventions.

Updated Apr 25, 2026

Search Tags:#documentation #onboarding #project context #codebase scanning #role-based guidance #contributor enablement

Ready to run

npx skills add https://github.com/easonlao/jiazi-game --skill onboard-easonlao

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/easonlao/jiazi-game/tree/main/.claude/skills/onboard
Command: npx skills add https://github.com/easonlao/jiazi-game --skill onboard-easonlao

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill reduces the time and confusion new contributors or agents face by producing a tailored onboarding document that summarizes the project state, relevant architecture, conventions, and immediate priorities for a specified role or area.

Core Features & Use Cases

Context loading from project standards: Reads CLAUDE.md to align with repository conventions and expectations.
Role/area-directed discovery: Scans the most relevant directories (src/, design/, tests/, production/) based on the requested role or area to gather up-to-date information.
Actionable onboarding output: Produces a structured document including key directories/files, current state, sprint context, dependencies, pitfalls, and first tasks.

Quick Start

Ask the AI to generate onboarding for a role by running: onboard [role|area].

Frequently Asked Questions about onboard

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

FAQPage Schema

How do I generate project onboarding documentation for new contributors?▼

Project onboarding documentation is generated by scanning relevant directories like src, design, and tests, then summarizing project state, architecture, and conventions into a structured Markdown file tailored for a specific role or area.

How does role-based onboarding for a codebase work?▼

Role-based onboarding works by reading repository conventions from CLAUDE.md, optionally loading agent definitions under .claude/agents/, and scanning directories to produce role-specific guidance covering key files, current state, and first tasks.

What is the best way to orient a new agent across code, design, and production materials?▼

Orienting a new agent across project materials requires generating a contextual document that summarizes architecture, conventions, dependencies, pitfalls, and sprint context to provide immediate orientation and actionable first tasks.

Do I need a CLAUDE.md file to create contributor enablement docs?▼

Yes, a CLAUDE.md file is required to align with repository conventions and expectations, serving as the foundational context for generating accurate, structured onboarding documentation for new contributors or agents.

Can I use codebase scanning to produce onboarding docs for a specific development area?▼

Yes, codebase scanning supports area-directed discovery by targeting the most relevant directories based on the requested role or area, gathering up-to-date information to produce a structured onboarding output.

What limitations exist when generating onboarding documents for a new role?▼

Limitations include relying on the presence and accuracy of CLAUDE.md and optional agent definitions, as the onboarding document quality depends entirely on scanning existing repository directories and available project context.