SuperAPI AI 工具集

understand-onboard

通用与其它

查看项目

更新于 10-15 21:37

技能介绍

用途:为新成员生成项目入职指南,内容来自项目知识图谱,而非人工编写。

主要能力:从知识图谱的 project 元数据提取名称、描述、语言与框架;用 layers 组织架构分层;用 tour 生成引导式学习路径;用文件级节点(file、config、document、service、pipeline、table、schema、resource、endpoint)生成文件地图;按 complexity 值识别复杂度热点。输出为 Markdown,包含项目概览、架构分层、关键概念、引导式导览、文件地图、复杂度热点,并可保存到 docs/UA_ONBOARDING.md 建议提交到仓库。

使用方式:先解析数据目录,运行 UA_DIR=$([ -d .understand-anything ] && echo .understand-anything || echo .ua),确认 $UA_DIR/knowledge-graph.json 存在,否则提示先运行 /understand。使用前检查图谱新鲜度:读取 project.gitCommitHash,解析为提交后与 git rev-parse HEAD 比较,并检查项目范围内的已提交与工作区变更,命令包括 git rev-parse --verify --end-of-options "${GRAPH_COMMIT_RAW}^{commit}"、git rev-parse HEAD、git diff --name-only "$GRAPH_COMMIT" HEAD -- .、git diff --cached --name-only -- .、git diff --name-only -- .、git ls-files --others --exclude-standard -- .。-- . 路径限定必须保留,避免同级 monorepo 项目提交误判为过期;仅哈希不一致而项目差异为空不算过期。所有命令输出需忽略所选数据目录。若已提交差异或工作区命令报告项目文件,生成前警告内容可能遗漏这些变更,并建议运行 /understand 刷新图谱。仅当 GRAPH_COMMIT_RAW 成功解析时才运行提交差异;缺失或无效时给出简要警告并继续。读取时建议先用 Grep 搜索 JSON 再读取所需部分,避免整图载入上下文。

限制:依赖已生成的知识图谱;图谱过期时指南可能不完整;仅处理文件级结构节点,不展开函数与类级细节;未提供收费、平台或效果信息。