Understand onboard
Skill Garr1k/Understand-Anything/understand-anything-plugin/skills/understand-onboard
Use when you need to generate an onboarding guide for new team members joining a projectFrom its SKILL.md
npx -y skills add Garr1k/Understand-Anything --skill understand-onboardAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
3.3 KB, 755 tokens by cl100k_base, as published. Nobody here has run it
/understand-onboard
Generate a comprehensive onboarding guide from the project's knowledge graph.
Graph Structure Reference
The knowledge graph JSON has this structure:
project— {name, description, languages, frameworks, analyzedAt, gitCommitHash}nodes[]— each has {id, type, name, filePath?, summary, tags[], complexity, languageNotes?}- Code node types: file, function, class, module, concept
- Non-code node types: config, document, service, table, endpoint, pipeline, schema, resource
- Domain/knowledge node types: domain, flow, step, article, entity, topic, claim, source
- IDs use the node type as prefix, e.g.
file:path,function:path:name,config:path,article:path
edges[]— each has {source, target, type, direction, weight}- Key types: imports, contains, calls, depends_on, configures, documents, deploys, triggers, contains_flow, flow_step, related, cites
layers[]— each has {id, name, description, nodeIds[]}tour[]— each has {order, title, description, nodeIds[]}
How to Read Efficiently
- Use Grep to search within the JSON for relevant entries BEFORE reading the full file
- Only read sections you need — don't dump the entire graph into context
- Node names and summaries are the most useful fields for understanding
- Edges tell you how components connect — follow imports and calls for dependency chains
Instructions
-
Check that
.understand-anything/knowledge-graph.jsonexists. If not, tell the user to run/understandfirst. -
Read project metadata — use Grep or Read with a line limit to extract the
"project"section (name, description, languages, frameworks). -
Read layers — Grep for
"layers"to get the full layers array. These define the architecture and will structure the guide. -
Read the tour — Grep for
"tour"to get the guided walkthrough steps. These provide the recommended learning path. -
Read file-level structural nodes only — use Grep to find nodes with file-level types (
file,config,document,service,pipeline,table,schema,resource,endpoint) in the knowledge graph. Skip function-level and class-level nodes to keep the guide high-level. Extract each node'sname,filePath,summary, andcomplexity. -
Identify complexity hotspots — from the file-level nodes, find those with the highest
complexityvalues. These are areas new developers should approach carefully. -
Generate the onboarding guide with these sections:
- Project Overview: name, languages, frameworks, description (from project metadata)
- Architecture Layers: each layer's name, description, and key files (from layers + file nodes)
- Key Concepts: important patterns and design decisions (from node summaries and tags)
- Guided Tour: step-by-step walkthrough (from the tour section)
- File Map: what each key file does (from file-level nodes, organized by layer)
- Complexity Hotspots: areas to approach carefully (from complexity values)
-
Format as clean markdown
-
Offer to save the guide to
docs/ONBOARDING.mdin the project -
Suggest the user commit it to the repo for the team