skills.rest
ejoongseok
ejoongseokCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

on-boarding

Convert a repository into structured onboarding documentation with YAML frontmatter.

8|2|Updated May 3, 2026
Search Tags:#documentation generation#API documentation#project onboarding#repository analysis#architecture mapping#developer enablement#Claude Code setup
One-click install
npx skills add https://github.com/ejoongseok/claude-settings --skill on-boarding
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: on-boarding
Source: https://github.com/ejoongseok/claude-settings/tree/main/claude-code/skills/on-boarding
Command: npx skills add https://github.com/ejoongseok/claude-settings --skill on-boarding

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of onboarding team members to an unfamiliar codebase by turning scattered project files into a coherent, actionable set of standards and references.

Core Features & Use Cases

  • Project-wide onboarding artifact generation: Produces a standardized output set for a new project, including root guidance plus bot/human entry points and local Claude rule/team documentation.
  • Systematic codebase analysis with configurable depth and focus: Detects stack, structure, and conventions, and optionally performs deeper cross-file analysis with selectable focus areas such as API, database, infrastructure, testing, and devops.
  • Incremental context staging for accuracy: Writes stepwise findings into intermediate markdown files and then assembles final documents, using only verified discoveries and defined fallbacks when files are missing.
  • Safety guardrails for overwriting existing docs: Detects pre-existing onboarding outputs and asks for user confirmation before overwriting.

Quick Start

Use the on-boarding skill to analyze the current project folder and generate the CLAUDE.md, bot/., human/README.md, and .local.claude/.md onboarding documents using deep analysis by default.

Frequently Asked Questions about on-boarding

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

FAQPage Schema
How do I generate onboarding documentation for an existing codebase?▼

To generate onboarding documentation, the skill analyzes your repository's structure, conventions, and context to produce a complete package including CLAUDE.md, bot/human entry points, and local rule files.

What is the best way to map a project's architecture for new developers?▼

Mapping project architecture for new developers is handled by analyzing the codebase with configurable depth, allowing you to select focus areas like API, database, or infrastructure to produce targeted architecture fact catalogs.

Does the documentation generation process overwrite existing markdown files?▼

The documentation generation process includes safety guardrails that detect pre-existing onboarding artifacts and require explicit user confirmation before overwriting any existing markdown files.

Can I focus API documentation generation on specific parts of a repository?▼

You can focus API documentation generation on specific repository areas by passing configurable arguments, enabling deeper cross-file analysis on selected domains such as API, testing, or devops.

How does repository analysis ensure accurate architecture mapping?▼

Repository analysis ensures accurate architecture mapping by staging incremental context, writing verified findings into intermediate markdown files first, and using defined fallbacks for missing files before assembling final documents.

What files do I need for project onboarding setup with Claude Code?▼

Project onboarding setup requires an existing repository folder, from which the skill generates the necessary files including root guidance, local Claude rules, and team documentation for developer enablement.

Related Skills

Explore More Software Engineering Skills→
garethrhughesgarethrhughes
5

project-onboard

Analyze repository files to infer project conventions and generate CLAUDE.md content.

Community
Advanced
vercel-labsvercel-labs
15.9k

remotion

Convert JSON timeline specs into playable Remotion video compositions.

Official
Intermediate
georgekhananaevgeorgekhananaev
27

code-quality

Enforce cross-language code quality standards across TypeScript, Python, Go, and Rust.

Community
Advanced
raalzateraalzate
3

static-inference-expert-kiro

Analyze Java/.NET projects to generate dependency graphs and architecture proposals.

Community
Advanced