# Onboard

> ---

- Skill: `tranhieutt/onboard` (Agent Skill)
- Install (CLI): `npx skillmds@latest add tranhieutt/onboard`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tranhieutt/onboard/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tranhieutt (https://skillmd.com/u/tranhieutt)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tranhieutt/onboard

---

---
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:

1. **Read the CLAUDE.md** for project overview and standards.

2. **Read the relevant agent definition** from `.claude/agents/` if a specific
   role is specified.

3. **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

4. **Read recent changes** (git log if available) to understand current momentum.

5. **Generate the onboarding document**:

```markdown
# 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]
```