onboard

Generate role-specific onboarding Markdown documents from repository files and git history.

Updated Apr 9, 2026
One-click install
npx skills add https://github.com/CarlosQ96/robot-crawler --skill onboard-carlosq96
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: onboard
Source: https://github.com/CarlosQ96/robot-crawler/tree/main/.agents/skills/onboard
Command: npx skills add https://github.com/CarlosQ96/robot-crawler --skill onboard-carlosq96

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creates a concise, role-specific onboarding document so new contributors or autonomous agents quickly understand project state, architecture, conventions, and immediate priorities without manually hunting through repositories and communications.

Core Features & Use Cases

  • Contextual Project Summary: Reads AGENTS.md and agent definitions to summarize standards and responsibilities relevant to a given role or area.
  • Area Scanning: Scans designated directories (e.g., src/, design/, tests/, production/) and recent git history to extract architecture, key files, and current work in progress.
  • Document Generation & Save: Produces a structured onboarding Markdown file with suggested first tasks, pitfalls, and questions, and can prompt to save the file to production/onboarding/onboard-[role]-[date].md.
  • Use Case: Onboard a new programmer by generating a role-specific guide that lists key directories, initial tasks, coding conventions, and current sprint expectations.

Quick Start

Generate an onboarding document for the programmer role using AGENTS.md and recent repository changes, present the result, and ask to save it to production/onboarding/onboard-programmer-[date].md.

Frequently Asked Questions about onboard

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

FAQPage Schema
How do I generate onboarding documentation for new project contributors?

Generate onboarding documentation by scanning designated directories like src/ and tests/, reading AGENTS.md files, and analyzing recent git commits to produce a role-specific markdown guide. The resulting file summarizes architecture, conventions, priorities, and suggested first tasks.

Can I create role-specific onboarding guides for different team members like designers and QA?

Yes, you can create role-specific onboarding guides for programmers, designers, narrative writers, QA, and production staff. The tool scans role-relevant directories and generates tailored markdown files with conventions, architecture summaries, and suggested initial tasks for each specific role.

What's the best way to onboard autonomous agents into a code repository?

Onboard autonomous agents by reading AGENTS.md and agent definitions to extract project standards and responsibilities. The system summarizes architecture and current work in progress, producing a contextual markdown document that helps agents quickly understand repository state and immediate priorities.

Does project onboarding require any dependencies or external components?

No, project onboarding requires no external dependencies or components. It operates independently using read, glob, grep, and write capabilities to scan repository files, extract role-relevant information, and optionally save the resulting markdown to production/onboarding with role and date.

How does scanning recent commits improve contributor onboarding?

Scanning recent commits improves contributor onboarding by extracting current work in progress and immediate sprint priorities. Combined with directory scanning and AGENTS.md analysis, this contextual approach ensures new contributors understand both project architecture and active development focus.

Where are generated onboarding documents saved in the repository?

Generated onboarding documents are optionally saved to production/onboarding/onboard-[role]-[date].md. The system prompts to write the structured markdown file containing architecture summaries, coding conventions, pitfalls, and suggested first tasks to this location.