onboard

Generate role-specific onboarding documents from CLAUDE.md and agent definitions.

Updated Apr 26, 2026
One-click install
npx skills add https://github.com/solace-ill/vector-flow --skill onboard-solace-ill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/solace-ill/vector-flow/tree/main/.claude/skills/onboard
Command: npx skills add https://github.com/solace-ill/vector-flow --skill onboard-solace-ill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates contextual onboarding documents that summarize project state, architecture, conventions, and current priorities for the specified role or area, helping new contributors ramp faster.

Core Features & Use Cases

  • Generate role-specific onboarding documents by synthesizing project context from CLAUDE.md and agent definitions.
  • Scan relevant areas (src, design, tests, production) to tailor content for the targeted role.
  • Save and share a structured onboarding document ready for onboarding sessions.

Quick Start

Provide the role or area and execute the onboarding generator to produce a tailored document.

Frequently Asked Questions about onboard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate developer onboarding documents from CLAUDE.md?

Developer onboarding documents are generated by synthesizing project context from CLAUDE.md and agent definitions. The Skill scans relevant project areas like src, design, and tests to create a structured guide tailored to the specified role.

Can I create role-specific onboarding guides for new contributors?

Yes, role-specific onboarding guides are created by tailoring the synthesized project context to the targeted audience. You provide the role or area, and the generator produces a customized onboarding document for that contributor.

What is the best way to document project context for new contributors ramping up?

Documenting project context for new contributors is best handled by generating a structured onboarding guide that summarizes architecture, conventions, and current priorities. This provides role-specific context to help developers ramp up faster.

How does contextual onboarding scan and use project areas like src and tests?

Contextual onboarding scans relevant project areas including src, design, tests, and production to gather required state and conventions. It applies this scanned context to tailor the generated onboarding document to the specific task.

Do I need agent definitions to produce a structured onboarding document?

Agent definitions are required alongside CLAUDE.md to synthesize the complete project context. Loading both inputs allows the generator to accurately tailor and save the structured onboarding document to the production directory.

Where does the generated onboarding document get saved for sharing?

The generated onboarding document is saved directly to the production/onboarding directory. This ensures the structured guide is stored and ready for onboarding sessions with new contributors.