SuperAPI AI 工具集

onboarding

通用与其它

查看项目

更新于 10-15 21:39

技能介绍

用途:爬取仓库并在仓库根目录生成 ONBOARDING.md,帮助新贡献者理解代码库;适用于代码编写速度快于文档更新的项目。

主要能力:从代码本身重建心智模型;每次都从头生成文档,不读取也不比对旧版本,若 ONBOARDING.md 已存在则直接覆盖;文档面向人类读者,包含至多六个部分(纯基础设施且无消费方时可省略第 2 部分,共五节),用 ASCII 图、表格和反引号标注路径、命令与代码引用;只陈述可观察到的事实,不虚构设计理由,不评估脆弱性;绝不包含密钥,只引用环境变量名,若 .env 含真实密钥则只提取变量名;已有文档覆盖良好时以内联链接代替重复说明。

使用方式:第 1 阶段运行随附清单脚本 node scripts/inventory.mjs --root . 获取仓库结构映射,解析 JSON 输出(项目名、语言、框架、包管理器、测试框架、目录结构、入口点、可用脚本、已有文档、测试基础设施、外部依赖、monorepo 结构);脚本失败或返回 error 字段时向用户报告并停止,不用不完整数据写文档。第 2 阶段用原生文件读取工具按优先级并行读取关键文件:README.md、清单列出的入口点、路由/控制器文件、揭示架构和外部依赖的配置文件(仅读 .env.example/.env.sample,绝不读 .env 本身)、AGENTS.md 或 CLAUDE.md、与本节直接相关的文档;不投机读取文件。第 3 阶段综合写入仓库根目录,标题用 # {项目名} Onboarding Guide;写作使用第二人称、主动语态、现在时,直接具体,避免填充语、模糊总结、对冲词、营销用语和文档元评论;每个 ## 节之间插入水平分隔线;代码块宽度不超过 80 列,架构图最多每行两个框、标签不超过 20 字符,目录树内联注释不超过 30 字符。

六个部分:第 1 节说明项目做什么、面向谁、解决什么问题;第 2 节按消费方命名为用户体验、开发者体验或用户与开发者体验,纯基础设施可跳过;第 3 节说明架构、关键模块、连接方式和外部依赖,含目录树、模块表、依赖表,依赖表列出用途和配置方式,无外部依赖时明确说明;第 4 节定义领域术语和架构抽象;第 5、6 节的内容资料未提供。

限制:不读取或 diff 旧版本文档;不包含密钥;不编造设计理由或脆弱性评估;脚本失败即停止;资料未提供平台、收费、价格和效果等信息。