create-onboarding-guide

Generate a developer onboarding guide with Day 1 / Week 1 / Month 1 progression.

6|Updated Feb 19, 2026
One-click install
npx skills add https://github.com/GeneralJerel/chalk-skills --skill create-onboarding-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-onboarding-guide
Source: https://github.com/GeneralJerel/chalk-skills/tree/main/skills/create-onboarding-guide
Command: npx skills add https://github.com/GeneralJerel/chalk-skills --skill create-onboarding-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a complete, runnable onboarding guide that helps teams ramp up developers quickly by synthesizing existing documentation and code.

Core Features & Use Cases

  • Structured Day 1 / Week 1 / Month 1 onboarding that covers environment setup, first commit, architecture overview, and ownership.
  • Automated documentation synthesis from .chalk/docs/ directories and codebase to produce a coherent learning path.
  • Gap identification and tracking by listing missing docs as actionable TODOs for future work.

Quick Start

Scan the repository's docs and code, then generate and save a complete onboarding guide as .chalk/docs/ai/<n>_onboarding_guide.md

Frequently Asked Questions about create-onboarding-guide

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

FAQPage Schema
How do I generate a developer onboarding guide from existing repository documentation?

To generate a developer onboarding guide, the Skill scans your repository's .chalk/docs/ directories and codebase to synthesize a structured Day 1 / Week 1 / Month 1 reading path. It outputs a comprehensive markdown file with runnable steps and required references.

What is the best way to structure a developer ramp-up plan for new hires?

The best way to structure a developer ramp-up plan is using a Day 1 / Week 1 / Month 1 progression. This covers environment setup, first commit, architecture overview, and ownership, ensuring new developers progress logically through their onboarding journey.

How do I identify missing documentation gaps in my codebase during knowledge transfer?

You can identify documentation gaps by analyzing the repository codebase and existing docs to find missing information. The Skill lists these missing docs as actionable TODOs within the generated onboarding guide for future knowledge transfer work.

Can I automate the creation of a runbook from existing developer docs and code?

Yes, you can automate runbook creation by pulling content from existing .chalk/docs/ directories and the codebase. The Skill synthesizes these sources to produce an ordered reading list, marking required versus reference documentation automatically.

Does the onboarding guide generation work without any external dependencies?

Yes, the onboarding guide generation works without external dependencies. The Skill operates independently to scan repository docs and code, requiring only your existing codebase and .chalk/docs/ directories to build the complete learning path.

What is included in the Day 1 section of an automated onboarding guide?

The Day 1 section includes environment setup and the first commit. It is part of a structured progression that pulls runnable steps and required documentation from your codebase to get developers contributing immediately.