Skip to content
Get packs

Project Onboarding Guide

Generates a new-team-member onboarding guide from a project's existing knowledge graph

Source Download skill
Repository
Egonex-AI/Understand-Anything
Stars
89,744
Licence
MIT
Files
1 file

What it does

When installed, the agent can turn a previously generated code knowledge graph (a structured JSON map of the project's files, components, layers and suggested tour) into a readable onboarding guide covering project overview, architecture layers, key concepts, a guided tour, a file map and complexity hotspots. It also checks whether the graph is out of date compared with recent Git changes, warns if so, and offers to save the guide as a markdown file in the repo.

Great for

  • Engineering leads who want a starting document for new hires joining an existing codebase
  • Teams that already ran the companion /understand command and want a readable summary of its output

Skip it if

  • Projects where /understand has never been run, since the skill stops and asks for the graph first
  • Situations needing guaranteed-accurate docs: the guide is only as current as the graph, and the skill may continue with a stale graph after only a warning

Try asking

  • “/understand-onboard”
  • “Create an onboarding guide for our new backend engineers”
  • “Generate a markdown onboarding doc from the knowledge graph and suggest where to save it”
Step-by-step guide: how to use Project Onboarding GuideInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    understand-onboard.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip understand-onboard.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip understand-onboard.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Run /understand to refresh the graph before generating the guide if the agent reports project changes since the last analysis
  • Review the generated guide before committing it, since it is derived from automated summaries that may contain errors
  • Ask the agent to save the guide to docs/UA_ONBOARDING.md, then commit it so the whole team can use it

What's inside

  • SKILL.md

Redistributed unmodified from Egonex-AI/Understand-Anything under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.