agentleFS
LeonardoEnnesLeonardoEnnes/ai-engineering-toolkit/.agents/skills/onboard-dev/SKILL.md

onboard-dev

Skill0 starsChanged 10 days agoApache-2.0View on GitHub

Guides the onboarding of new developers or agents into the repository, generating an architectural map and system overview using Mermaid diagrams.

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Document required local tools, environment variables, and execution steps to run tests successfully.

    line 20
  2. Distinctive:

    All core architectural boundaries and modules are correctly identified and summarized.

    line 24

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Onboard Developer Skill

Intent

Rapidly orient developers or AI agents to the repository's architecture, core boundaries, domain models, and key execution flows without manual document reading.

Obligations

  1. Architectural Mapping:
    • Scan the directory structure, identify the core layers (e.g., Domain, Application, Infrastructure), and map entry points.
    • Summarize the tech stack, main frameworks, and configuration requirements.
  2. Visual Flow Generation:
    • Generate a clear mermaid diagram illustrating the high-level system architecture or request lifecycle.
  3. Prerequisite & Setup Verification:
    • Document required local tools, environment variables, and execution steps to run tests successfully.

How to verify

  • A generated onboarding summary includes a valid Mermaid diagram and actionable local execution commands.
  • All core architectural boundaries and modules are correctly identified and summarized.

Antipatterns (Do NOT do)

  • Generating generic, template-based descriptions that do not reflect the actual codebase structure.
  • Omitting environment prerequisites or critical setup gotchas.

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.