SuperAPI AI 工具集

ce-onboarding

通用与其它

查看项目

更新于 10-15 21:39

技能介绍

用途:为代码库自动生成根目录 ONBOARDING.md,帮助新贡献者理解项目,无需项目创建者口头解释。适合文档滞后于代码的快速迭代仓库。

主要能力:先运行内置盘点脚本 node scripts/inventory.mjs --root . 获取结构信息,包括项目名、语言、框架、包管理器、测试框架、目录结构、入口点、可用命令、已有文档、测试设施、外部依赖与 monorepo 结构;脚本失败则报告并停止,不用不完整数据写文档。然后读取关键文件:README.md、入口点、路由/控制器、配置文件(如 docker-compose.yml、.env.example,绝不读取 .env)、AGENTS.md 或 CLAUDE.md,以及相关文档。

输出:写入仓库根目录的 ONBOARDING.md,标题为 # {项目名} Onboarding Guide,含六个章节:项目是什么、如何使用(按消费者类型命名,如 User Experience、Developer Experience)、如何组织(架构图、用户流程、目录树、模块表、外部依赖表)、关键概念与抽象等;纯基础设施可省略第二章。始终从头重新生成,不读取或比对旧版本,已有文件会被覆盖。

风格与限制:面向人类写作,用第二人称、主动语态、现在时,具体而非含糊;用 ASCII 图与表格,代码块不超过 80 列;所有文件路径、命令与代码引用使用反引号。不得编造设计理由或脆弱性评估;绝不包含 API 密钥、令牌、密码等机密,只引用环境变量名。文档链接已有资料而不重复。若无法从代码确定用途,应明确说明。