understand-onboard

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.