菜单
Instant Project Onboarding — generate a complete onboarding guide for any project. Use when user wants to onboard a new developer, understand a new codebase, or generate project documentation.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Build a regression + eval harness for AI-written code and AI features. Generates characterization tests that lock current behavior before a refactor, scaffolds a Promptfoo eval suite for chatbots/RAG/classifiers, and wires it into the ship-gate. Use when the user wants evals, regression tests for AI code, to stop AI features drifting, or to test an LLM feature.
Run security audit — dependency vulnerabilities, secret scanning, OWASP pattern detection, HTTP headers. Use when user wants to harden their project.
Accessibility audit + auto-fix (WCAG 2.2 A/AA). Scans built/static HTML for screen-reader, keyboard, and structure failures, fixes the deterministic ones, and escalates to a rendered scan for contrast and focus. Use when the user wants to check or improve accessibility, fix WCAG issues, or pass an a11y review.
Turn the /ship scorecard into a blocking, config-as-code quality gate. Sets per-category score thresholds, hard-fails on leaked secrets or critical findings, and wires the gate into a pre-push hook and CI so nothing below the bar merges. Use when the user wants a merge gate, CI quality gate, pre-push check, or to enforce ship-readiness.
Post-deploy canary monitoring — checks site health, detects regressions, monitors for errors after deployment. Use after deploying to verify production is healthy.
Code review with principal-engineer-level depth. Reviews for correctness, performance, security, maintainability, and architecture. Use when completing tasks, reviewing PRs, or before merging.
| name | onboard |
| description | Instant Project Onboarding — generate a complete onboarding guide for any project. Use when user wants to onboard a new developer, understand a new codebase, or generate project documentation. |
| allowed-tools | Bash, Read, Grep, Glob, Write |
One command generates everything a new developer needs to be productive in your codebase.
node ${CLAUDE_PLUGIN_ROOT}/tools/onboard-generator.mjs <project-directory>
Parse the JSON output.
Format the output as a comprehensive onboarding document:
Project Overview:
Architecture Diagram: Display the Mermaid architecture diagram from the tool output. This gives new developers an instant visual understanding.
Getting Started:
Key Files: Table of the most important files and their roles. New developers should read these first.
API Routes: Table of all detected API routes with methods, paths, and source files.
Database:
Recent Activity: Last 10 commits — gives context on what the team is currently working on.
Gotchas: Known issues and common problems new developers encounter.
Save the onboarding guide to docs/ONBOARDING.md in the project:
# [Project Name] — Developer Onboarding
> Auto-generated by Ultraship on [date]
## Overview
...
## Architecture
```mermaid
[diagram]
...
...
...
...
...
### Phase 4: Identify Knowledge Gaps
After generating the guide, identify areas that need human input:
- Undocumented environment variables
- Missing README sections
- No contributing guidelines
- No architecture decision records (ADRs)
Suggest creating these if they don't exist.
## Key Principle
**30-minute rule.** A new developer should be able to run the project locally within 30 minutes of reading this guide. If they can't, the guide is incomplete.