understand-onboard

Generate an onboarding guide from a project's knowledge graph JSON.

6|1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/kmshihab7878/claude-code-setup --skill understand-onboard
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: understand-onboard
Source: https://github.com/kmshihab7878/claude-code-setup/tree/main/skills/understand-onboard
Command: npx skills add https://github.com/kmshihab7878/claude-code-setup --skill understand-onboard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

New team members often face a steep ramp because project knowledge is fragmented across code, docs, and implicit architecture. This Skill automates assembly of a concise, structured onboarding guide by extracting high-level project metadata, architecture layers, guided tours, and key file summaries from a project's knowledge graph.

Core Features & Use Cases

  • Project Overview Extraction: Pulls project name, description, languages, and frameworks from the graph metadata to create a one-page summary.
  • Architecture Layers & File Map: Reads layers and file-level nodes to map major components and what each key file does.
  • Guided Tour & Key Concepts: Converts the tour entries and node summaries into a step-by-step learning path and highlights important patterns and design decisions.
  • Complexity Hotspot Detection: Identifies high-complexity files to recommend areas that require extra onboarding attention.
  • Use Case: Onboard a new engineer by generating a markdown ONBOARDING document that includes overview, architecture, guided steps, and files to review first.

Quick Start

Generate an onboarding guide using the knowledge graph file located at .understand-anything/knowledge-graph.json.

Frequently Asked Questions about understand-onboard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an onboarding guide from a project knowledge graph?

To generate an onboarding guide from a project knowledge graph, this Skill reads the .understand-anything/knowledge-graph.json file to extract project metadata, architecture layers, and file-level nodes into a structured markdown document.

What is a knowledge graph onboarding guide and how does it work?

A knowledge graph onboarding guide is a structured markdown document that assembles project overviews, architecture summaries, and file maps by reading node metadata and complexity metrics directly from a JSON knowledge graph.

How do I create a project overview and file map for new engineers?

You can create a project overview and file map by extracting project name, languages, frameworks, and file-level nodes from the knowledge graph, which automatically identifies major architectural components and key file summaries.

Can I detect complexity hotspots in my codebase for onboarding focus?

Yes, you can detect complexity hotspots by filtering file-level nodes in the knowledge graph by complexity metrics, which identifies high-complexity files that require extra onboarding attention and review.

Do I need a specific knowledge-graph JSON format to generate architecture layer summaries?

Yes, you need a specifically formatted knowledge-graph JSON file located at .understand-anything/knowledge-graph.json, which must contain project metadata, architecture layers, tour entries, and file-level nodes to function correctly.

What's the best way to automate codebase onboarding documentation from existing project graphs?

The best way to automate codebase onboarding documentation is to extract guided tours, architecture summaries, and key concepts from existing knowledge graph nodes, converting them directly into a step-by-step learning path markdown file.