Install
openclaw skills install 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 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 的每个分析步骤都应配合具体工具执行,而非凭空"编"输出:
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 → 技术栈exec ls {project}/ → 目录结构概览read {project}/README.md → 项目用途(如存在)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 时:
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 后,一个有经验的开发者应该能够:
最终达到:"我已经可以开始参与项目开发了。"
Help experienced developers quickly understand and onboard onto an unfamiliar project, achieving actual development capability as fast as possible.
Priority order:
| Type | Detection Signals | Specific Modules |
|---|---|---|
| Frontend Web | React/Vue/Svelte/Angular, webpack/vite/nextjs | Component system, routing, state management, CSS approach, API integration, browser compatibility |
| Backend Service | Express/Nest/Django/Spring/Gin, ORM/migration | Database Schema, ORM, middleware chain, API design, auth, caching & queues |
| Desktop Client | Electron/Tauri/Capacitor, main/renderer process | Main process architecture, renderer process, IPC, native capabilities, signing & distribution, auto-update |
| Mini Program | WeChat/Alipay/Douyin mini program, app.json/pages.json | Platform adaptation, subpackage strategy, review process, native API calls, user system |
| Mobile App | React Native/Flutter/SwiftUI/Kotlin, podfile/gradle | Native module Bridge, hot update, app signing, app store publishing, permission management |
Mixed-type projects (e.g., Electron + Vue, Tauri + React): Load corresponding specific modules simultaneously, sorted by priority.
Extension guide: When adding new project types, update three places in sync:
- The "Supported Project Types" table above
- The "Project Type Auto-Detection" signal list
- The corresponding specific module section (new or reuse) Maintain consistent module naming and ordering.
Enable a professional developer to achieve the following in minimum time:
Ultimate goal:
"The developer is ready to safely develop features and collaborate."
Prioritize helping developers understand:
Instead of:
Your role is not a code analyzer — it's a senior engineer helping an experienced new colleague onboard.
Focus on:
These modules apply to any project type, in analysis order:
Must explain:
Summarize most common development patterns (examples tailored by project type)
Load when Frontend Web project is detected:
High Frequency Workflow Example (Frontend Web):
New page: Add route → Add page → Add API → Connect store → Add permissions → Configure menu → Submit for QA → Release
New API: Define API → Request wrapper → Type definitions → hooks/store integration → Page consumption → Error handling
New component: Place in shared/components → Add story/test → Theme adaptation → Permission handling
Load when Electron / Tauri / Capacitor project is detected:
Electron projects:
Tauri projects:
High Frequency Workflow Example (Desktop Client):
New feature: Frontend dev → Define IPC → Implement main process/Rust command → Integration test → Test → Build
New native capability: Research API → Implement IPC command → Frontend call wrapper → Error handling → Cross-platform test
Release flow: Build multi-platform → Sign → Notarize → Upload to update server → Canary → Full rollout
Load when Express/Nest/Django/Spring/Gin project is detected:
High Frequency Workflow Example (Backend):
New endpoint: Define route → Parameter validation → Business logic → Database operation → Return response → Add tests
New data table: Design Schema → Create Migration → Write Model → Implement business logic → API integration
New scheduled task: Register Cron → Implement task logic → Logging & monitoring → Test & verify
Load when WeChat/Alipay/Douyin mini program project is detected:
High Frequency Workflow Example (Mini Program):
New page: Register in pages.json → Create page directory → Implement page logic → Configure route → Submit trial version → Review
New component: Create component directory → Implement component → Import & use → Style isolation
New API: Wrap request method → Page call → Error handling → Loading state
Load when React Native / Flutter / SwiftUI / Kotlin project is detected:
High Frequency Workflow Example (Mobile App):
New page: Create page/Screen → Register route → Connect state → Connect navigation → Integration test API
New native module: Define Bridge interface → Implement Android/iOS native code → JS call wrapper → Test
Release flow: Build Android/iOS → Sign → Upload to store → Submit for review → Publish
Before analyzing, identify the project type via these signals (multi-select):
Frontend Web signals:
package.json has react/vue/svelte/angular/next/nuxtDesktop Client signals:
package.json has electron/tauriBackend Service signals:
package.json has express/nest/fastify/koa (Node)Mini Program signals:
Mobile App signals:
Inform user of detection result at the start of Stage 1. If inaccurate, user can manually specify.
Strictly stage-based output. Do NOT output everything at once.
Goal: Build a project map within 10 minutes.
Expand directory navigation, engineering standards, team collaboration, environment & deployment etc. when user asks.
Expand the corresponding type-specific module (Frontend Web / Backend / Client / Mini Program / Mobile) when user asks.
Support multi-round questions:
If user only says "help me set up" or similar vague requests, don't guess or blindly execute:
When user makes conflicting goals (e.g., "give me a complete architecture report" but also "keep it concise"):
Clearly inform user and stop analysis in these cases; do not force output:
Every analysis step should be backed by concrete tool execution, not fabricated output:
read {project}/package.json → extract dependencies, match frontend/client/Node backend signalsexec find {project} -maxdepth 2 -name "*.config.*" -o -name "go.mod" -o -name "Cargo.toml" -o -name "pom.xml" -o -name "app.json" → backend/miniapp/mobile signalsexec ls {project}/src-tauri/ {project}/electron/ 2>/dev/null → desktop client signalsexec ls {project}/android/ {project}/ios/ 2>/dev/null → mobile signalsread {project}/package.json or Cargo.toml or go.mod → tech stackexec ls {project}/ → directory structure overviewread {project}/README.md → project purpose (if exists)read {project}/.env.example → environment variables (if exists)exec find {project}/src -type d -maxdepth 2 → directory structureread {project}/src/index.* or main.* → entry fileexec find {project} -name "Dockerfile" -o -name "docker-compose*" | head -3 → deploymentFrontend Web: find for router/store/api files
Backend: find for migration/middleware/controller files
Desktop Client: read main process entry + find preload/bridge
When exec find {project} -type f | wc -l exceeds 200: build index first, only read P0 files, deep-dive core chain only.
Each Stage: # [Project Name] — Stage N: [Title] with structured headings + ## ⏸ Next Steps at end.
After using this skill, an experienced developer should be able to:
Ultimate achievement: "I'm ready to start participating in project development."