SuperAPI AI 工具集

create-onboarding-guide

前端与建站

查看项目

更新于 10-15 19:58

技能介绍

用途:为代码仓库生成一份自包含的 HTML 上手指南,让新人一次性了解项目结构、主要流程和代码位置。

主要能力:输出单个 HTML 文件(内联 style、script、SVG,无 CDN),包含仓库头部信息、架构图、可折叠目录树、关键流程讲解、约定与注意事项、推荐阅读顺序和入门命令。

使用方式:先解析输出目录,读取 ${CLAUDE_PLUGIN_ROOT}/config.json 的 outputDir,或技能级 config.json 覆盖;两者都不存在时参考 config.example.json 并询问用户绝对路径。确认目标仓库和受众后,探索代码库,梳理布局、架构、2–3 条关键流程及约定,再生成 HTML。文件名格式为 <repo>-onboarding-<yyyyMMdd>.html,保存到输出目录,若 openAfterGenerate 为真则打开文件并报告路径。

适用场景:新工程师或外部贡献者快速熟悉仓库。

限制:仓库过大时需限定范围;纯库项目可改为讲解公共 API 和代表性用法。具体配置细节和命令以实际仓库为准。