understand-onboard
installsforks
How to install understand-onboard?
egonex-ai/understand-anything/understand-onboard
$npx -y skills add Egonex-AI/Understand-Anything --skill understand-onboardUse when you need to generate an onboarding guide for new team members joining a project
SKILL.md
| 1 | # /understand-onboard |
| 2 | |
| 3 | Generate a comprehensive onboarding guide from the project's knowledge graph. |
| 4 | |
| 5 | ## Graph Structure Reference |
| 6 | |
| 7 | The knowledge graph JSON has this structure: |
| 8 | - `project` — {name, description, languages, frameworks, analyzedAt, gitCommitHash} |
| 9 | - `nodes[]` — each has {id, type, name, filePath?, summary, tags[], complexity, languageNotes?} |
| 10 | - Code node types: file, function, class, module, concept |
| 11 | - Non-code node types: config, document, service, table, endpoint, pipeline, schema, resource |
| 12 | - Domain/knowledge node types: domain, flow, step, article, entity, topic, claim, source |
| 13 | - IDs use the node type as prefix, e.g. `file:path`, `function:path:name`, `config:path`, `article:path` |
| 14 | - `edges[]` — each has {source, target, type, direction, weight} |
| 15 | - Key types: imports, contains, calls, depends_on, configures, documents, deploys, triggers, contains_flow, flow_step, related, cites |
| 16 | - `layers[]` — each has {id, name, description, nodeIds[]} |
| 17 | - `tour[]` — each has {order, title, description, nodeIds[]} |
| 18 | |
| 19 | ## How to Read Efficiently |
| 20 | |
| 21 | 1. Use Grep to search within the JSON for relevant entries BEFORE reading the full file |
| 22 | 2. Only read sections you need — don't dump the entire graph into context |
| 23 | 3. Node names and summaries are the most useful fields for understanding |
| 24 | 4. Edges tell you how components connect — follow imports and calls for dependency chains |
| 25 | |
| 26 | ## Instructions |
| 27 | |
| 28 | 1. **Resolve the data directory `$UA_DIR`.** Run `UA_DIR=$([ -d .understand-anything ] && echo .understand-anything || echo .ua)` — this is the legacy `.understand-anything/` when it already exists, otherwise the new `.ua/`. Check that `$UA_DIR/knowledge-graph.json` exists. If not, tell the user to run `/understand` first. |
| 29 | |
| 30 | 2. **Check graph freshness before using graph-derived context**: |
| 31 | - Read `project.gitCommitHash` from the graph metadata as `GRAPH_COMMIT_RAW`. Resolve it as a commit before using it in any Git diff, then compare it with `git rev-parse HEAD` and inspect project-scoped committed and working-tree changes from the project root: |
| 32 | ```bash |
| 33 | GRAPH_COMMIT=$(git rev-parse --verify --end-of-options "${GRAPH_COMMIT_RAW}^{commit}" 2>/dev/null) |
| 34 | git rev-parse HEAD |
| 35 | git diff --name-only "$GRAPH_COMMIT" HEAD -- . |
| 36 | git diff --cached --name-only -- . |
| 37 | git diff --name-only -- . |
| 38 | git ls-files --others --exclude-standard -- . |
| 39 | ``` |
| 40 | - The `-- .` pathspec is required: commits that only touch a sibling monorepo project must not make this graph stale. A hash mismatch alone is not stale when the project diff is empty. |
| 41 | - Ignore the selected data directory (`.ua/` or legacy `.understand-anything/`) in every command's output because it contains generated graph artifacts, not project source drift. |
| 42 | - If the committed diff or any working-tree command reports project files, warn before generating the guide that onboarding content may omit those changes. Suggest: Run `/understand` to refresh the graph. |
| 43 | - Run the commit diff only when `GRAPH_COMMIT_RAW` resolves successfully. If the graph commit or Git metadata is missing, invalid, or unavailable, give a brief best-effort warning and continue instead of blocking. |
| 44 | |
| 45 | 3. **Read project metadata** — use Grep or Read with a line limit to extract the `"project"` section (name, description, languages, frameworks). |
| 46 | |
| 47 | 4. **Read layers** — Grep for `"layers"` to get the full layers array. These define the architecture and will structure the guide. |
| 48 | |
| 49 | 5. **Read the tour** — Grep for `"tour"` to get the guided walkthrough steps. These provide the recommended learning path. |
| 50 | |
| 51 | 6. **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's `name`, `filePath`, `summary`, and `complexity`. |
| 52 | |
| 53 | 7. **Identify complexity hotspots** — from the file-level nodes, find those with the highest `complexity` values. These are areas new developers should approach carefully. |
| 54 | |
| 55 | 8. **Generate the onboarding guide** with these sections: |
| 56 | - **Project Overview**: name, languages, frameworks, description (from project metadata) |
| 57 | - **Architecture Layers**: each layer's name, description, and key files (from layers + file nodes) |
| 58 | - **Key Concepts**: important patterns and design decisions (from node summaries and tags) |
| 59 | - **Guided Tour**: step-by-step walkthrough (from the tour section) |
| 60 | - **File Map**: what each key file does (from file-level nodes, organized by layer) |
| 61 | - **Complexity Hotspots**: areas to approach carefully (from complexity values) |
| 62 | |
| 63 | 9. Format as clean markdown |
| 64 | 10. Offer to save the guide to `docs/ONBOARDING.md` in the project |
| 65 | 11. Suggest the user commit it to the repo for the team |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
