skills.rest
AO-HyS
AO-HySOFFICIAL
Explore all skills by this author →
WebsiteGitHub

understand-onboard

Generates a markdown onboarding guide from a project knowledge graph JSON file.

Updated Jun 28, 2026
Search Tags:#architecture#documentation#markdown#onboarding#knowledge graph#codebase#developer guide
One-click install
npx skills add https://github.com/AO-HyS/aohys.com --skill understand-onboard-ao-hys
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: understand-onboard
Source: https://github.com/AO-HyS/aohys.com/tree/main/.agents/skills/understand-onboard
Command: npx skills add https://github.com/AO-HyS/aohys.com --skill understand-onboard-ao-hys

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? New team members joining a project often struggle to understand the codebase structure, architecture layers, and which files matter most. This Skill turns an existing project knowledge graph into a structured onboarding guide so newcomers can ramp up without manually exploring every file. ## Core Features & Use Cases - Architecture Overview: Extracts project metadata, layers, and file-level nodes from the knowledge graph to describe the system structure. - Guided Tour: Reproduces the recommended learning path from the graph's tour section as a step-by-step walkthrough. - Complexity Hotspots: Identifies high-complexity files so new developers know which areas to approach carefully. - Use Case: A new engineer joins a team whose project was analyzed with the /understand command. Run this Skill to produce an ONBOARDING.md covering the project overview, architecture layers, key concepts, file map, and complexity hotspots, then commit it to the repo for the whole team. ## Quick Start Ask the assistant to generate an onboarding guide for this project from the knowledge graph and save it to docs/ONBOARDING.md.

Frequently Asked Questions about understand-onboard

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

FAQPage Schema
How do I create an onboarding guide for a new codebase?▼

Run the /understand command first to build the knowledge graph, then invoke this Skill. It reads the graph's project metadata, layers, tour, and file-level nodes to produce a markdown guide covering architecture, key concepts, and complexity hotspots.

What is a knowledge graph JSON for code analysis?▼

It is a structured JSON file describing a project with nodes (files, functions, classes, modules), edges (imports, calls, dependencies), architecture layers, and a guided tour. This Skill consumes that structure to summarize the project for newcomers.

What happens if the knowledge graph file does not exist?▼

The Skill checks for .understand-anything/knowledge-graph.json before proceeding. If the file is missing, it instructs you to run the /understand command first to generate the graph.

Does the onboarding guide include function-level details?▼

No. The guide intentionally reads only file-level nodes and skips function-level and class-level nodes to keep the output high-level and readable for new team members.

Where is the generated onboarding guide saved?▼

After generating the markdown guide, the Skill offers to save it to docs/ONBOARDING.md in the project and suggests committing it to the repository so the whole team can use it.

Related Skills

Explore More Software Engineering Skills→
ignidusignidus

codebase-understanding

Decompose codebases into a knowledge graph of files, functions, and architecture.

Official
Advanced
OM-bit-hubOM-bit-hub

onboard-dev

Generate a structured onboarding guide covering architecture, setup, and starter tasks.

Community
Advanced
DVNghiemDVNghiem
20

code-tour

Generate structured Markdown code tours with validated file paths.

Community
Advanced
henrybravohenrybravo

documentation-synthesis

Generate Markdown documentation from code comments and OpenAPI or GraphQL schemas.

Community
Advanced