SuperAPI AI 工具集

create-onboarding-guide

办公与效率

查看项目

更新于 10-15 22:41

技能介绍

用途:当用户要求编写入职文档、入门指南或记录环境搭建流程时,生成结构化的开发者入职指南。

主要能力:扫描 .chalk/docs/ 目录树(product、engineering、ai 及根目录),梳理已有文档与缺口;用 Bash 和 Glob 检查代码库结构(依赖文件、构建与运行脚本、测试框架、环境配置、CI/CD、lint 与格式化工具);按 $ARGUMENTS 确定项目、团队、目标角色与重点,未指定则生成通用全栈指南;产出 Day 1(环境搭建与首次提交)、Week 1(架构理解与首个真实贡献)、Month 1(功能归属与横切关注点)三段内容,并附推荐阅读顺序、常见坑点与“文档 TODO”。

使用方式:技能读取 .chalk/docs/ 文档与代码库,按参数确定范围,验证命令与项目文件一致,最后写入 .chalk/docs/ai/<n>_onboarding_guide.md(纯 Markdown,无 YAML frontmatter,首行为 # Developer Onboarding Guide)。

适用场景:新成员入职、团队交接、需要把散落文档整理为可执行学习路径时。

限制:依赖 .chalk/docs/ 中已有文档,缺失内容只能标记为文档缺口;不编造未提供的功能、收费或平台信息;具体命令与项目细节需以实际仓库为准。