SuperAPI AI 工具集

extract-glossary

通用与其它

查看项目

更新于 10-15 21:48

技能介绍

用途:从代码库生成人类 onboarding 资料兼 AI 知识库,避免 AI 反复询问相同术语与结构。可输入本地 checkout 路径、GitHub URL、多仓库列表或 organization 名加筛选条件;输出到现有 docs、.claude/skills/<domain>-glossary/ 或任意 Markdown 文件。输入含糊时先确认候选 repo 与输出目标,但若能合理定位则先开始探索。

成果物标准结构:<domain>-glossary/ 下含 SKILL.md、references/glossary.md、references/repository-map.md、references/architecture.md、assets/architecture-diagrams.md。glossary 分行业、领域、组织内、实现固有名、基础设施等类别,每词附含义、分类、主要实现 repo、依据 URL、注意点、确度(confirmed/inferred/needs-check)。repository-map 记录各 repo 职责、主要目录、入口、外部依赖、边界。architecture 覆盖技术栈、数据流、基础设施、部署、运维注意。

调查流程:先确定范围与分支/commit,本地可用 git remote -v 和 git rev-parse HEAD;优先读 README、CLAUDE.md、AGENTS.md、docs、ADR、OpenAPI、GraphQL、Protobuf、SQL schema、IaC、包清单与入口路由文件;避开 node_modules、vendor、生成代码、构建产物、压缩文件、lockfile 细节及大量日志。用 rg --files 与 rg 检索。

Mermaid 图保持一图一主题,约 10 节点、15 边,subgraph 不过深,edge label 简短,协议与运行时通信不混入同图。出典只用 GitHub URL、官方 docs 或用户提供的永久 URL,不写本地绝对路径。

提交前检查:rg 查 '../'、'/Users/'、'/home/';git diff --check;统计 Mermaid fence;有 mmdc 则渲染验证,否则在报告中说明。回复需区分现状与推定,不混用行业与组织内用语,onboarding 用途须写阅读顺序与调查入口,SKILL.md 保持轻薄、细节放 references。仅当用户要求才进入 git commit/push/PR 流程。其余细节暂未提供。