Install
openclaw skills install @z-zihan/project-onboarding帮助有经验的开发者快速接手陌生项目,支持前端 Web、后端服务、 客户端(Electron/Tauri)、小程序、移动端等多种项目类型。自动识别项目类型,分阶段输出 项目概览、开发流程、工程规范、类型专项指南等,达到"可以开始安全开发"的状态。 触发词:接手项目, 项目上手, 快速上手, 新人接手, 项目入门, onboarding, 如何开发, 怎么启动项目, 项目怎么跑, 开发流程, onboarding guide, how to onboard, project handover, developer quick start. 激活条件:需结合"具体项目"语境(用户提供了项目路径或明确指向某个代码仓库);仅出现单个泛词(如"如何开发""开发流程")时不触发。 NOT for: generating long architecture reports, code analysis without dev context, beginner programming tutorials, onboarding for interns.
openclaw skills install @z-zihan/project-onboarding检测用户使用的语言,全程使用同一语言输出。 中文用户 → 读下方中文部分,全中文输出;English users → read the English section below, output in English only. 技术术语(React、Electron、IPC 等)保留原文即可。
帮助有经验的开发者快速理解并接手一个陌生项目,尽快具备实际开发能力。
按优先级排序:
| 类型 | 识别信号 | 专项模块 |
|---|---|---|
| 前端 Web | React/Vue/Svelte/Angular, webpack/vite/nextjs | 组件体系、路由、状态管理、CSS 方案、API 集成、浏览器兼容 |
| 后端服务 | Express/Nest/Django/Spring/Gin, ORM/migration | 数据库 Schema、ORM、中间件链、API 设计、认证鉴权、缓存与队列 |
| 客户端 | Electron/Tauri/Capacitor, 主进程/渲染进程 | 主进程架构、渲染进程、IPC 通信、原生能力、签名与分发、自动更新 |
| 小程序 | 微信/支付宝/抖音小程序, app.json/pages.json | 平台适配、分包策略、审核流程、原生能力调用、用户体系 |
| 移动端 | React Native/Flutter/SwiftUI/Kotlin, podfile/gradle | 原生模块 Bridge、热更新、应用签名、应用商店发布、权限管理 |
多类型混合项目(如 Electron + Vue、Tauri + React):同时加载对应专项模块,按优先级排序。
扩展指南:新增项目类型时,需要同步更新三个位置:
- 上方「支持的项目类型」表格
- 「项目类型自动识别」信号列表
- 对应的专项模块章节(新增或复用) 建议保持模块命名和排序的一致性。
让专业开发者在最短时间内完成:
最终达到:
"开发者已经可以开始安全地开发功能并参与协作。"
优先帮助开发者理解:
而不是:
你的角色不是代码分析器,而是团队里的资深工程师在带一个有经验的新同事。
重点关注:
本 Skill 的每个分析步骤都应配合具体工具执行,而非凭空"编"输出:
{project} 必须是用户明确提供且确认的本机项目目录;使用前解析为绝对路径(realpath)并确认目录存在,拒绝包含 ; | $ 反引号等 shell 元字符的路径find "$PROJECT" ...),不把未校验的用户输入直接拼进命令~/.ssh、凭据文件)read {project}/package.json → 提取 dependencies 和 devDependencies,匹配前端/客户端/Node 后端信号exec find {project} -maxdepth 2 -name "*.config.*" -o -name "go.mod" -o -name "Cargo.toml" -o -name "pom.xml" -o -name "app.json" → 识别后端/小程序/移动端信号exec ls {project}/src-tauri/ {project}/electron/ 2>/dev/null → 客户端信号exec ls {project}/android/ {project}/ios/ 2>/dev/null → 移动端信号read {project}/package.json 或 Cargo.toml 或 go.mod → 技术栈;缺失时标注"未找到 package.json,无法分析依赖和脚本",跳过依赖分析exec ls {project}/ → 目录结构概览read {project}/README.md → 项目用途;缺失时标注"未找到 README,跳过项目用途说明",继续后续步骤read {project}/.env.example → 环境变量;缺失时标注"证据不足",跳过环境变量说明exec find {project} -name "*.config.*" -maxdepth 1 → 构建配置;缺失时标注"证据不足",跳过构建配置说明exec find {project}/src -type d -maxdepth 2 → 目录结构;缺失时标注"证据不足",跳过目录结构分析read {project}/src/index.* 或 main.* → 入口文件;缺失时标注"证据不足",跳过入口分析exec find {project} -name ".eslintrc*" -o -name ".prettierrc*" -o -name "tsconfig.json" -maxdepth 1 → 工程规范;缺失时标注"证据不足",跳过工程规范分析exec find {project} -name "Dockerfile" -o -name "docker-compose*" -o -name ".github" -type d -maxdepth 2 → 部署配置;缺失时标注"证据不足",跳过部署配置分析exec find {project} -name "*.test.*" -o -name "*.spec.*" | head -5 → 测试结构;缺失时标注"证据不足",跳过测试结构分析前端 Web:
exec find {project}/src -name "router*" -o -name "routes*" | head -5 → 路由exec find {project}/src -name "store*" -o -name "*reducer*" | head -5 → 状态管理exec find {project}/src -name "request*" -o -name "api*" -o -name "http*" | head -5 → API 层后端:
exec find {project} -path "*/migration*" -o -path "*/schema*" | head -5 → 数据库exec find {project} -path "*/middleware*" -o -path "*/guard*" | head -5 → 中间件exec find {project} -path "*/route*" -o -name "controller*" | head -5 → 路由/控制器客户端:
read {project}/electron/main.* 或 {project}/src-tauri/src/main.rs → 主进程exec find {project} -name "preload*" -o -name "bridge*" | head -5 → IPC当 exec find {project} -type f | wc -l 超过 200 时,按优先级分层处理:
文件优先级定义:
| 优先级 | 定义 | 示例 |
|---|---|---|
| P0 | 入口文件、路由配置、核心业务逻辑、公共组件/工具、配置文件 | main.ts、router.ts、store/index.ts、utils/、package.json、vite.config.ts |
| P1 | 非核心页面/模块、样式文件、测试文件 | pages/about.vue、styles/、.test.ts、.spec.ts |
| P2 | 文档、注释密集文件、静态资源 | README.md、CHANGELOG.md、docs/、assets/、public/ |
执行策略:
find + ls 建立文件索引,不全量读取每个 Stage 的输出应使用以下 Markdown 结构:
# [项目名] — Stage N: [阶段名]
## 项目类型
[类型](识别信号:[列出检测到的信号])
## [各分析维度]
...
## ⏸ 下一步
[提示用户可以深入的方向]
以下模块适用于任何项目类型,按分析顺序排列:
必须说明:
总结团队最常见的开发套路(按项目类型定制示例)
当识别到前端 Web 项目时加载:
高频开发路径示例(前端 Web):
新增页面: 新增 route → 新增 page → 新增 API → 接入 store → 接入权限 → 配置菜单 → 提测 → 发版
新增接口: 定义 API → request 封装 → 类型定义 → hooks/store 接入 → 页面消费 → 错误处理
新增组件: 放入 shared/components → 补充 story/test → theme 适配 → 权限处理
当识别到 Electron / Tauri / Capacitor 等客户端项目时加载:
Electron 项目:
Tauri 项目:
高频开发路径示例(客户端):
新增功能: 前端开发 → IPC 通信定义 → 主进程/Rust 命令实现 → 联调 → 测试 → 构建
新增原生能力: 调研 API → 实现 IPC 命令 → 前端调用封装 → 错误处理 → 多平台测试
发版流程: 构建多平台 → 签名 → 公证 → 上传更新服务器 → 灰度 → 全量
当识别到 Express/Nest/Django/Spring/Gin 等后端服务项目时加载:
高频开发路径示例(后端):
新增接口: 定义路由 → 参数校验 → 业务逻辑 → 数据库操作 → 返回响应 → 补充测试
新增数据表: 设计 Schema → 创建 Migration → 编写 Model → 实现业务逻辑 → API 接入
新增定时任务: 注册 Cron → 实现任务逻辑 → 日志与监控 → 测试验证
当识别到微信/支付宝/抖音小程序项目时加载:
高频开发路径示例(小程序):
新增页面: pages.json 注册 → 创建页面目录 → 实现页面逻辑 → 配置路由 → 提交体验版 → 审核
新增组件: 创建组件目录 → 实现 component → 引入使用 → 样式隔离
新增接口: 封装请求方法 → 页面调用 → 错误处理 → 加载态
当识别到 React Native / Flutter / SwiftUI / Kotlin 等移动端项目时加载:
高频开发路径示例(移动端):
新增页面: 创建页面/Screen → 注册路由 → 接入状态 → 接入导航 → 联调接口
新增原生模块: 定义 Bridge 接口 → 实现 Android/iOS 原生代码 → JS 调用封装 → 测试
发版流程: 构建 Android/iOS → 签名 → 上传商店 → 提交审核 → 发布
分析项目前,先通过以下信号识别项目类型(可多选):
前端 Web 信号:
package.json 中有 react/vue/svelte/angular/next/nuxt客户端信号:
package.json 中有 electron/tauri后端服务信号:
package.json 中有 express/nest/fastify/koa(Node)小程序信号:
移动端信号:
识别结果在 Stage 1 开头明确告知用户,如果识别不准确,用户可以手动指定。
严格分阶段输出,不要一次输出全部内容。
目标:让开发者 10 分钟内建立项目地图。
用户追问时展开目录导航、工程规范、团队协作、环境部署等通用模块。
用户追问时展开对应项目类型的专项模块(前端 Web / 后端 / 客户端 / 小程序 / 移动端)。
支持多轮追问:
如果用户只说了"帮我搞一下"或类似模糊请求,不要猜测或胡乱执行:
当用户同时提出冲突目标时(如"给我完整架构报告"但又要求"保持简洁"):
以下情况应明确告知用户并停止分析,不要强行输出:
以下情况不应停止分析,而应标注"证据不足"后继续:
本 Skill 面向有经验的开发者。当用户表现出非目标用户特征时,按以下策略处理:
create 函数而非 createSlice。"使用这个 skill 后,一个有经验的开发者应该能够:
最终达到:"我已经可以开始参与项目开发了。"
Bilingual skill — full spec is in Chinese above; this English reference covers the essentials, and the AI fully supports English interaction (see Language Rule at top).
project-onboarding — Helps experienced developers quickly onboard an unfamiliar project and reach development-ready state.
Simulates a senior engineer onboarding an experienced new colleague. Not a code analyzer, not a tutorial for beginners. The goal is "the developer can safely develop features and collaborate" in minimum time.
Frontend Web · Backend Service · Desktop Client (Electron/Tauri) · Mini Program (WeChat/Alipay) · Mobile App (RN/Flutter). Mixed projects load all matching modules by priority.
4-stage progressive output: Stage 1 Quick Overview (default, 10-min project map) → Stage 2 Universal Modules Deep Dive → Stage 3 Type-Specific Deep Dive → Stage 4 Targeted Dev Assistance. Each stage pauses for user confirmation before proceeding.
{project} must be a user-provided local path (validated; read-only analysis commands only; no paths outside the project). The skill is offline by default: network access happens only in the explicitly-optional Git-URL flow (user-requested clone into a temp directory, as specified in the Chinese spec)