onboard
Skill40 starsChanged 7 months agoMITView on GitHub
Generates a contextual onboarding doc for a new contributor based on their role (engineer, designer, PM, QA, etc.). Summarizes app concept, architecture, conventions, current sprint, and the contributor's likely first tasks. Use when bringing someone new onto the project or when a contributor switches roles.
165 other projects use a version of this.
Adopted by
Most recently taken up by
- ggoosen/Digital-Workforcetheir own version, first seen Nov 8, 2026
- joeldevz/skynex-pitheir own version, first seen Nov 8, 2026
- eggs-gd/career-spacetheir own version, first seen Nov 8, 2026
- Codename-11/SubFrametheir own version, first seen Nov 8, 2026
- passion4it-gmbh/passionfruit-sitetheir own version, first seen Nov 5, 2026
- striderZA/OpenCodeGameStudiostheir own version, first seen Nov 4, 2026
Used with
Projects with it also use teach-impeccable, team-level and 2 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
HK-hubSkillteach-impeccable
One-time setup that gathers design context for your project and saves it to your AI config file. Run once to establish persistent design guidelines.
Also in 19 projects that use this
CoralGameSkillteam-level
Orchestrate level design team: level-designer + narrative-director + world-builder + art-director + systems-designer + qa-tester for complete area/level creation.
Also in 11 projects that use this
CoralGameSkillteam-narrative
Orchestrate the narrative team: coordinates narrative-director, writer, world-builder, and level-designer to create cohesive story content, world lore, and narrative-driven level design.
Also in 11 projects that use this
- +1 more from CoralGame
Other versions165 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 165
- Donchitos/Claude-Code-Game-Studios★ 27ksame name
- parcadei/Continuous-Claude★ 3.9ksame name
- parcadei/Continuous-Claude-v2★ 3.9ksame name
- parcadei/Continuous-Claude-v3★ 3.9ksame name
- nateherkai/AIS-OS★ 1.4ksame name
- poshan0126/dotclaude★ 871same name
- talesofai/cohub★ 585same name
- me2resh/apexyard★ 542same name
- nexmoe/DayBee★ 424same name
- nexmoe/eve★ 424same name
155 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository77 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- design/CLAUDE.mdCLAUDE.md
- docs/CLAUDE.mdCLAUDE.md
- src/CLAUDE.mdCLAUDE.md
- tests/CLAUDE.mdCLAUDE.md
- adoptSkill
- architecture-decisionSkill
- architecture-reviewSkill
- asset-auditSkill
- asset-specSkill
- balance-checkSkill
- brainstormSkill
- bug-reportSkill
- bug-triageSkill
- changelogSkill
- code-reviewSkill
- consistency-checkSkill
- content-auditSkill
- create-architectureSkill
- create-control-manifestSkill
- create-epicsSkill
- create-storiesSkill
- day-one-patchSkill
- design-bibleSkill
- design-reviewSkill
- design-systemSkill
- dev-storySkill
- estimateSkill
- extractSkill
- gate-checkSkill
- helpSkill
- hotfixSkill
- launch-checklistSkill
- localizeSkill
- map-systemsSkill
- milestone-reviewSkill
- patch-notesSkill
- perf-profileSkill
- prd-reviewSkill
- project-stage-detectSkill
- propagate-design-changeSkill
- prototypeSkill
- qa-planSkill
- quick-designSkill
- regression-suiteSkill
- release-checklistSkill
- retrospectiveSkill
- reverse-documentSkill
- review-all-prdsSkill
- scope-checkSkill
- security-auditSkill
- setup-frameworkSkill
- skill-improveSkill
- skill-testSkill
- smoke-checkSkill
- soak-testSkill
- sprint-planSkill
- sprint-statusSkill
- startSkill
- story-doneSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
12 rules. 0 are common, 6 are distinctive, and 6 are very specific to this project.
0
Common
Most of the 153 edited versions we read keep these.
6
Distinctive
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 25
Do not run when no concept doc exists — onboarding without context is a tour of an empty room.
- Distinctive: line 31
All design, architecture, production artifacts on disk
- Distinctive: line 41
If no role argument was passed, ask:
- Very specific: line 53
If --name <person> is included, the doc personalizes the welcome.
- Distinctive: line 59
Read what exists. If a file is missing, note it as "not yet authored" — never invent content.
- Distinctive: line 126
First tasks: run smoke check; read 3 specific stories due for QA hand-off
- Distinctive: line 137
If the user described their role in free text, structure the doc with:
- Very specific: line 155
If team contacts are not known, leave them as [name TBD] — do not invent.
- Distinctive: line 164
If the user wants edits, capture them, redraft, ask again.
- Very specific: line 167
Update production/session-state/active.md if it is being maintained
- Very specific: line 190
If a critical artifact is missing (no concept doc, no framework pin), the skill must surface that as a blocker rather than write a doc full …
- Very specific: line 198
Do not duplicate /help's job.
“Common” is measured: kept by at least 6 in 10 of the 153 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Contributor Onboarding
Produces a single onboarding document tailored to the role. The doc is meant to be read once on day one and revisited a few times in week one — it is not a manual replacement for the codebase.
Output: production/onboarding/[role]-[date].md
Purpose / When to Run
Run when:
- A new contributor is joining the project
- An existing contributor is moving from one role to another (e.g., backend → mobile)
- The user wants a "what would I tell someone new about this project" snapshot
Do not run when no concept doc exists — onboarding without context is a tour of an empty room. Direct the user to /start first.
Inputs
- Role argument (required)
- Optional
--name <person>for personalization - All design, architecture, production artifacts on disk
Outputs
production/onboarding/[role]-[YYYY-MM-DD].md
Phase 1: Resolve Role
If no role argument was passed, ask:
- Prompt: "Which role is the onboarding for?"
- Options:
Engineer (mobile)— implements stories, writes testsDesigner (UX/visual)— authors UX specs and the design biblePM / producer— owns sprint plans, scope, milestonesQA / tester— runs test plans, files bugs, gates releasesData scientist / analytics— instrumentation, metricsOther— describe in free text
Capture the role as a kebab-case slug for the filename (engineer, designer, pm, qa, analytics, or whatever the user gives).
If --name <person> is included, the doc personalizes the welcome.
Phase 2: Gather Project Context
Read what exists. If a file is missing, note it as "not yet authored" — never invent content.
Always read:
design/concept.md.claude/docs/technical-preferences.mddesign/systems-index.md(if present)production/session-state/active.md(if present)
Role-specific reads:
| Role | Additional reads |
| Engineer | docs/architecture/architecture.md, docs/architecture/control-manifest.md, all Accepted ADRs, current sprint plan, docs/framework-reference/<framework>/VERSION.md |
| Designer | design/design-bible.md, all design/prd/*.md, all design/ux/*.md, the visual reference apps named in concept.md |
| PM | All sprint plans, all milestone docs, production/session-state/active.md, last 3 retrospectives |
| QA | All production/qa/ artifacts, current test plans, story types breakdown for the sprint |
| Analytics | concept.md Primary Metric, any analytics PRD, instrumentation ADRs |
Phase 3: Build Role-Specific Sections
The doc has a fixed shell, but content varies by role.
Common header (every role)
- Welcome (personalized if
--namegiven) - One-paragraph description of the app pulled from
concept.mdSection 1 + 3 - Target user (Section 2)
- Primary metric (Section 5)
- Current stage (run the same logic as
/project-stage-detectPhase 2 but inline; do not actually invoke that skill)
Engineer-specific
- Framework: name + version + LLM-knowledge-cutoff risk if known
- Architecture overview: top-level layers from
architecture.md - Key Accepted ADRs: list the 5-10 most-referenced ADRs by ID, title, and one-sentence decision
- Coding conventions: pulled from
.claude/docs/coding-standards.md - Control manifest highlights: top 5 forbidden patterns and top 5 required patterns
- Repo layout:
src/,tests/, the framework-specific dirs (ios/,android/,lib/, etc.) - First tasks: pull 2-3 stories with
Status: ReadyandLayer: FoundationorCorefrom current sprint. List file paths. - Tooling: build command, test command, lint command (read from
package.json,pubspec.yaml, or Makefile)
Designer-specific
- Design Bible status: token coverage + open sections
- PRD inventory: which systems have specs, which are stubs
- UX coverage: which screens have UX specs, which are missing
- Conventions: platform target (iOS HIG / Material 3 / both), accessibility floor (WCAG 2.2 AA)
- First tasks: missing UX specs for in-flight epics; PRDs with UI Requirements but no matching UX spec
- Reference apps: from
concept.mdSection 6
PM / producer-specific
- Current sprint: name, dates, story count by status
- Current milestone: name, target date, completion %
- Risk register: open blockers from
production/session-state/active.md - Recent retros: takeaways from the last 1-2 retrospectives
- Cadences in use: sprint length, gate skills the team uses, review-mode setting
- First tasks: review the active sprint plan, run
/sprint-status, talk to engineering lead about one named blocker
QA-specific
- Test framework (from technical preferences)
- Test counts: unit / integration / manual evidence
- Story type distribution in the current sprint
- Open bugs: count + severity from
production/qa/bugs/ - First tasks: run smoke check; read 3 specific stories due for QA hand-off
Analytics-specific
- North Star metric (from concept.md)
- Instrumentation status: any analytics PRD or ADR
- Tools: analytics provider if pinned (Amplitude, Mixpanel, Firebase, etc.)
- First tasks: define the event schema for the in-flight epic; align metric definitions with PM
Other
If the user described their role in free text, structure the doc with:
- Purpose of the role on this project
- Stakeholders they will interact with
- Files most-relevant to their work
- An open question for them to bring back to the team
Phase 4: Sketch the First-Week Plan
Tail the doc with a "First week" section covering 5 work-days. Be concrete:
- Day 1: read these files in this order
- Day 2: shadow [contact] / pair with [contact] on [task]
- Day 3: take ownership of [specific story or PRD]
- Day 4: run [skill] for the first time
- Day 5: present what you learned in a 30-min review
If team contacts are not known, leave them as [name TBD] — do not invent.
Phase 5: Write the Doc
Build the file content, then ask:
- "May I write this to
production/onboarding/[role]-[date].md?"
If the user wants edits, capture them, redraft, ask again.
After writing:
- Update
production/session-state/active.mdif it is being maintained - Print: "Doc written. Open it before [contributor]'s first day, share the path, and let them flag missing context — onboarding docs need updating after every cycle."
Examples
/onboard engineer --name Priya
- Reads concept doc, framework ref, architecture, control manifest, current sprint
- Picks 3 Ready stories from Foundation/Core layers as first tasks
- Surfaces the most-relevant ADRs (state management, networking, navigation)
- Writes
production/onboarding/engineer-2026-05-03.md
/onboard pm
- Reads sprint plans, milestone, active.md
- Tail-section recommends running
/sprint-statusand/scope-checkin week one - Lists stale stories that need re-triage
Quality Gates
- The doc must list at least one specific first task with a file path. Vague advice ("get familiar with the codebase") is a failure mode.
- If a critical artifact is missing (no concept doc, no framework pin), the skill must surface that as a blocker rather than write a doc full of
[TBD]. - The doc never invents people, ADRs, sprints, or tasks.
Constraints
- One file output, one role per run. To onboard multiple roles, run multiple times.
- Do not duplicate
/help's job./helpanswers "what should I do right now?" —/onboardanswers "what does this project look like to my role?"
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

