From ultraship
Generates complete onboarding guide for any project: overview, Mermaid architecture diagram, setup steps, key files, API routes, database schema, recent commits, gotchas. Saves to docs/ONBOARDING.md and flags gaps.
npx claudepluginhub houseofmvps/ultraship --plugin ultrashipThis skill is limited to using the following tools:
One command generates everything a new developer needs to be productive in your codebase.
Generates ONBOARDING.md by crawling repo structure with Node.js inventory script to onboard new contributors.
Generates onboarding documentation for projects: purpose, local setup, architecture overview, directory structure, key decisions, deployment steps. For day-one engineers. Triggers on 'onboarding docs', 'new engineer guide', 'getting started'.
Generates four audience-tailored onboarding guides in onboarding/ folder: Contributor (Python/JS), Staff Engineer, Executive, Product Manager. Resolves repo context first; for codebase intros.
Share bugs, ideas, or general feedback.
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.