---
name: onboard
type: workflow
description: "Generates a contextual onboarding document for a new contributor or agent joining the project, summarizing architecture, conventions, and current priorities. Use when onboarding a new team member, contributor, or agent."
argument-hint: "[role|area]"
user-invocable: true
allowed-tools: Read, Glob, Grep, Write
effort: 3
when_to_use: "When onboarding a new contributor or agent to the project for a specific role or area"
When this skill is invoked:
Read the CLAUDE.md for project overview and standards.
Read the relevant agent definition from .claude/agents/ if a specific
role is specified.
Scan the codebase for the relevant area:
For programmers: scan src/ for architecture, patterns, key files
For designers: scan design/ for existing design documents
For narrative: scan design/narrative/ for world-building and story docs
For QA: scan tests/ for existing test coverage
For production: scan production/ for current sprint and milestone
Read recent changes (git log if available) to understand current momentum.
Generate the onboarding document:
# Onboarding: [Role/Area]
## Project Summary
[2-3 sentence summary of what this product is and its current state]
## Your Role
[What this role does on this project, key responsibilities, who you report to]
## Project Architecture
[Relevant architectural overview for this role]
### Key Directories
| Directory | Contents | Your Interaction |
|-----------|----------|-----------------|
### Key Files
| File | Purpose | Read Priority |
|------|---------|--------------|
## Current Standards and Conventions
[Summary of conventions relevant to this role from CLAUDE.md and agent definition]
## Current State of Your Area
[What has been built, what is in progress, what is planned next]
## Current Sprint Context
[What the team is working on now and what is expected of this role]
## Key Dependencies
[What other roles/systems this role interacts with most]
## Common Pitfalls
[Things that trip up new contributors in this area]
## First Tasks
[Suggested first tasks to get oriented and productive]
1. [Read these documents first]
2. [Review this code/content]
3. [Start with this small task]
## Questions to Ask
[Questions the new contributor should ask to get fully oriented]
1---2name: onboard3description: ---4---5---6name: onboard7type: workflow8description: "Generates a contextual onboarding document for a new contributor or agent joining the project, summarizing architecture, conventions, and current priorities. Use when onboarding a new team member, contributor, or agent."9argument-hint: "[role|area]"10user-invocable: true11allowed-tools: Read, Glob, Grep, Write12effort: 313when_to_use: "When onboarding a new contributor or agent to the project for a specific role or area"14---1516When this skill is invoked:17181. **Read the CLAUDE.md** for project overview and standards.19202. **Read the relevant agent definition** from `.claude/agents/` if a specific21 role is specified.22233. **Scan the codebase** for the relevant area:24 - For programmers: scan `src/` for architecture, patterns, key files25 - For designers: scan `design/` for existing design documents26 - For narrative: scan `design/narrative/` for world-building and story docs27 - For QA: scan `tests/` for existing test coverage28 - For production: scan `production/` for current sprint and milestone29304. **Read recent changes** (git log if available) to understand current momentum.31325. **Generate the onboarding document**:3334```markdown35# Onboarding: [Role/Area]3637## Project Summary38[2-3 sentence summary of what this product is and its current state]3940## Your Role41[What this role does on this project, key responsibilities, who you report to]4243## Project Architecture44[Relevant architectural overview for this role]4546### Key Directories47| Directory | Contents | Your Interaction |48|-----------|----------|-----------------|4950### Key Files51| File | Purpose | Read Priority |52|------|---------|--------------|5354## Current Standards and Conventions55[Summary of conventions relevant to this role from CLAUDE.md and agent definition]5657## Current State of Your Area58[What has been built, what is in progress, what is planned next]5960## Current Sprint Context61[What the team is working on now and what is expected of this role]6263## Key Dependencies64[What other roles/systems this role interacts with most]6566## Common Pitfalls67[Things that trip up new contributors in this area]6869## First Tasks70[Suggested first tasks to get oriented and productive]71721. [Read these documents first]732. [Review this code/content]743. [Start with this small task]7576## Questions to Ask77[Questions the new contributor should ask to get fully oriented]78```
Run npx skillmds@latest add tranhieutt/onboard in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
--- It is listed under Coding & Dev Tools on SkillMD.
This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
tranhieutt (@tranhieutt) published this skill. Their other Agent Skills are listed on their SkillMD profile.