onboarding-template

> One-sentence description of what this does and who uses it.

Content Preview
# Onboarding Document Template

## README.md - Full Template

```markdown
# [Project Name]

> One-sentence description of what this does and who uses it.

[![CI](https://github.com/org/repo/actions/workflows/ci.yml/badge.svg)](https://github.com/org/repo/actions/workflows/ci.yml)
[![Coverage](https://codecov.io/gh/org/repo/branch/main/graph/badge.svg)](https://codecov.io/gh/org/repo)

## What is this?

[2-3 sentences: problem it solves, who uses it, current state]

**Live:** https://myapp.com  
How to Use

Recommended: Install to project (local)

mkdir -p .claude/skills
curl -o .claude/skills/onboarding-template.md \
  https://raw.githubusercontent.com/alirezarezvani/claude-skills/main/engineering/codebase-onboarding/references/onboarding-template.md

Skill is scoped to this project only. Add .claude/skills/ to your .gitignoreif you don't want to commit it.

Alternative: Clone full repo

git clone https://github.com/alirezarezvani/claude-skills

Then reference at engineering/codebase-onboarding/references/onboarding-template.md

Related Skills