agentleFS
dawn840705dawn840705/claude-code-studios/skills/onboard/SKILL.md

onboard

Skill1 starsChanged 3 months agoMITView on GitHub

Generates a contextual onboarding document for a new contributor or agent joining the project. Summarizes project state, architecture, conventions, and current priorities relevant to the specified role or area.

165 other projects use a version of this, 9 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use teach-impeccable.

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

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

The file

We split this skill into the rules it gives an agent

7 rules. 0 are common, 3 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 152 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read CLAUDE.md for project overview and standards.

    line 12
  2. Very specific:

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

    line 14
  3. Distinctive:

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

    line 26
  4. Very specific:

    Ask: "May I write this to production/onboarding/onboard-[role]-[date].md?"

    line 84
  5. Distinctive:

    If yes, write the file, creating the directory if needed.

    line 86
  6. Very specific:

    Run /sprint-status to show the new contributor current progress.

    line 95
  7. Very specific:

    Run /help if the contributor needs guidance on what to work on next.

    line 96

“Common” is measured: kept by at least 6 in 10 of the 152 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Phase 1: Load Project Context

Read CLAUDE.md for project overview and standards.

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


Phase 2: Scan 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.


Phase 3: Generate Onboarding Document

# Onboarding: [Role/Area]

## Project Summary
[2-3 sentence summary of what this game 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]

Phase 4: Save Document

Present the onboarding document to the user.

Ask: "May I write this to production/onboarding/onboard-[role]-[date].md?"

If yes, write the file, creating the directory if needed.


Phase 5: Next Steps

Verdict: COMPLETE — onboarding document generated.

  • Share the onboarding doc with the new contributor before their first session.
  • Run /sprint-status to show the new contributor current progress.
  • Run /help if the contributor needs guidance on what to work on next.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.