onboard-gen

Included with Lifetime

$97 forever

Generate onboarding documentation for new developers. Use when setting up new team members.

General

What this skill does

# Onboard Gen

New dev joins your team. They spend two weeks figuring out where things are. This tool generates onboarding docs from your codebase. Architecture overview, setup steps, key concepts. Everything they need to become productive fast.

**One command. Zero config. Just works.**

## Quick Start

```bash
npx ai-onboard ./src
```

## What It Does

- Scans your codebase and generates a getting started guide
- Creates architecture documentation explaining how pieces connect
- Produces setup instructions with environment variables and dependencies
- Documents key concepts, patterns, and conventions in your code
- Generates a FAQ based on common confusion points

## Usage Examples

```bash
# Generate onboarding docs for your project
npx ai-onboard ./src

# Include specific focus areas
npx ai-onboard ./src --focus auth,database,api

# Output as a single markdown file
npx ai-onboard ./src --output ONBOARDING.md
```

## Best Practices

- **Run from project root** - The tool needs context from package.json and config files
- **Keep a README updated** - The tool uses your README as additional context if it exists
- **Review and customize** - Add team-specific info like Slack channels and meeting schedules
- **Regenerate quarterly** - Your codebase changes. So should your onboarding docs.

## When to Use This

- New developer joining your team next week
- Open sourcing a project and need contributor docs
- Your onboarding docs are three years old and mention deprecated services
- Building a team wiki from scratch

## Part of the LXGIC Dev Toolkit

This is one of 110+ free developer tools built by LXGIC Studios. No paywalls, no sign-ups, no API keys on free tiers. Just tools that work.

**Find more:**
- GitHub: https://github.com/LXGIC-Studios
- Twitter: https://x.com/lxgicstudios
- Substack: https://lxgicstudios.substack.com
- Website: https://lxgic.dev

## Requirements

No install needed. Just run with npx. Node.js 18+ recommended.

```bash
npx ai-onboard --help
```

## How It Works

The tool analyzes your project structure, reads key files like package.json and config files, samples your source code, then generates documentation that explains how everything fits together. It focuses on what a new developer actually needs to know.

## License

MIT. Free forever. Use it however you want.

Files: 9

Size: 35.7 KB

Complexity: 42/100

Category: General

Source: https://github.com/boomsystel-code/openclaw-workspace/tree/main/skills/onboard-gen

Related in General

modeling-omnistudio-epc-catalog

Included

Salesforce Industries CME EPC product-modeling skill for Product2-based catalog creation. Use when creating EPC products, configuring product attributes, building offer bundles with Product Child Items, or reviewing EPC DataPack JSON metadata for product catalog changes. TRIGGER when: user creates or updates Product2 EPC records, AttributeAssignment payloads, AttributeMetadata/AttributeDefaultValues, Offer bundles, or ProductChildItem relationships. DO NOT TRIGGER when: designing OmniScripts/FlexCards/Integration Procedures (use building-omnistudio-omniscript, building-omnistudio-flexcard, or building-omnistudio-integration-procedure), implementing Apex business logic (use generating-apex), or troubleshooting deployment pipelines (use deploying-metadata).

Generalscripts

relationship-science-coach

Included

Use this skill for direct, practical adult relationship coaching: couples conflict, repair, trust, marriage, dating, flirting, attachment patterns, emotional connection, sex, desire differences, eroticism, kink negotiation, affection, love languages, breakups, and long-term passion. Draw on Gottman, EFT and Hold Me Tight, attachment science, modern sex research, Perel, Nagoski, Kerner, Schnarch, Love and Stosny, and flexible love-language tools. Be concrete and low-hedge. Redirect only for imminent danger, abuse, coercive control, minors, non-consent, self-harm, stalking, or medical/legal/psychiatric decisions.

Generalscripts

building-sf-integrations

Included

Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use configuring-connected-apps), Apex-only logic (use generating-apex), or data import/export (use handling-sf-data).

Generalscripts

venue-templates

Included

Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.

Generalscripts

let-fate-decide

Included

Draws the 12 Houses of the Zodiac Tarot spread to inject entropy into planning when prompts are vague, ambiguous, or casually delegated. Interprets the spread to guide next steps. Use when the user says 'let fate decide', 'YOLO', 'whatever', 'idk', or other nonchalant phrases, makes Yu-Gi-Oh references, or when you are about to arbitrarily pick between multiple reasonable approaches. Prefer over ask-questions-if-underspecified when the user's tone is casual or playful rather than precision-seeking.

Generalscripts

net-ops

Included

Cross-platform network troubleshooting (Windows, macOS, Linux) via local or remote shell. Use for: DNS broken, can't resolve hostnames, nslookup/dig works but apps fail, NRPT, WFP, scutil, /etc/resolver, systemd-resolved, /etc/resolv.conf, NetworkManager, VPN DNS leak residue (ProtonVPN/Mullvad/WireGuard/AnyConnect), AV/firewall blocking DNS or DoH, Tailscale DNS interaction, intermittent connectivity, remote diagnostics over SSH.

Generalscripts