Онбординг

TL;DR

Онбординг — процесс введения нового разработчика (или команды) в проект: документация, настройка окружения, знакомство с кодовой базой и процессами. Хороший онбординг сокращает время выхода на продуктивность с недель до дней.

Краткое определение

Онбординг — структурированный процесс адаптации нового сотрудника или разработчика в проекте: от настройки рабочего окружения до понимания архитектуры, процессов и принятия первых задач в работу.

Оригинал и перевод

• Язык: английский
• Оригинал: Onboarding (от on board — «на борт»)
• Буквальный перевод: введение на борт, принятие в команду
• Русские аналоги: адаптация, введение в должность, вводный курс

Синонимы и варианты написания

• Onboarding процесс
• Введение в проект
• Адаптация разработчика
• Orientation
• Ramp-up

Этапы онбординга разработчика

1️⃣ Pre-boarding (до первого дня)

Подготовка до выхода разработчика:

• ✅ Доступы к репозиторию (Git)
• ✅ Доступы к таск-трекеру (Jira, YouTrack)
• ✅ Доступы к документации (Confluence, Notion)
• ✅ Доступы к CI/CD (GitLab CI, GitHub Actions)
• ✅ Учётная запись в корпоративных системах
• ✅ Назначение ментора/buddy

2️⃣ Первый день

Знакомство и базовая настройка:

• ✅ Встреча с командой
• ✅ Обзор проекта и продукта
• ✅ Настройка локального окружения (Docker, PHP, Node.js)
• ✅ Клонируем репозиторий, запускаем проект
• ✅ Чек-лист первого дня

3️⃣ Первая неделя

Погружение в кодовую базу:

• ✅ Изучение архитектуры проекта
• ✅ Знакомство с кодгайдом и стандартами
• ✅ Первые простые задачи (fix typo, small bug)
• ✅ Code review первых PR
• ✅ Встреча 1-on-1 с тимлидом

4️⃣ Первый месяц

Самостоятельная работа:

• ✅ Самостоятельное выполнение задач
• ✅ Участие в планировании (planning poker)
• ✅ Знакомство с production окружением
• ✅ Понимание процессов деплоя и мониторинга

Компоненты хорошего онбординга

📚 Документация

Must-have документы:

• README.md — быстрый старт (клонировать, установить, запустить)
• ARCHITECTURE.md — структура проекта, основные модули
• DEVELOPMENT.md — настройка окружения, полезные команды
• DEPLOYMENT.md — как деплоить, куда, процессы
• CODING_STANDARDS.md — кодгайд, линтеры, пре-коммит хуки

Пример README.md:

# Project Name

## Быстрый старт

```bash
# Клонировать
git clone git@github.com:company/project.git

# Установить зависимости
composer install
npm install

# Настроить окружение
cp .env.example .env
# Отредактировать .env (DB credentials, API keys)

# Запустить локально
docker-compose up -d
npm run dev

# Открыть http://localhost:8080

Структура проекта

src/
├── Controller/    # Контроллеры
├── Model/         # Модели данных
├── Service/       # Бизнес-логика
└── Template/      # Представления

Полезные команды

• npm test — запустить тесты
• npm run lint — проверить код
• docker-compose logs -f — логи контейнеров

### 🛠 Настройка окружения
**Идеально:** один команд для запуска
```bash
# Docker Compose
docker-compose up -d

# Или Makefile
make up
make dev

# Или скрипт
./scripts/setup-dev.sh

Избегайте:

• ❌ «Установи PHP 8.1, MySQL 8, Redis, Node 18 вручную»
• ❌ «Скачай базу с прода и импортируй»
• ✅ «Одна команда — всё работает»

👥 Менторство (Buddy System)

Закрепление опытного разработчика за новым:

• Помощь в первых задачах
• Объяснение процессов и нюансов
• Регулярные встречи (daily первые 2 недели)
• Ответы на «глупые вопросы»

📋 Чек-листы

Чек-лист для каждого этапа:

## Первая неделя
- [ ] Настроил окружение
- [ ] Запустил проект локально
- [ ] Прочитал ARCHITECTURE.md
- [ ] Сделал первый коммит
- [ ] Прошёл code review

## Первый месяц
- [ ] Самостоятельно закрыл 3-5 задач
- [ ] Поучаствовал в деплое
- [ ] Понял процесс code review
- [ ] Знает, к кому обращаться по вопросам

Метрики онбординга

Типичные ошибки онбординга

• ❌ Нет документации — «разбирайся сам»
• ❌ Сложная настройка окружения — 2 дня на установку ПО
• ❌ Нет ментора — новый разработчик предоставлен сам себе
• ❌ Слишком сложные первые задачи — «возьмись-ка за рефакторинг ядра»
• ❌ Нет обратной связи — неясно, правильно ли я работаю
• ❌ Только устные объяснения — через неделю всё забылось

Аналоги и связанные термины

• Knowledge transfer — передача знаний
• Maintainability — поддерживаемость кода
• Documentation — документирование
• Code review — процесс ревью кода
• Mentorship — наставничество

Смотри также (статьи на сайте)

• Структура проекта Bitrix: local folder — организация кода
• Простой модуль Bitrix с компонентом — создание модулей

Смотри также (сниппеты)

• local/init.php: загрузчик — точка входа
• local/autoload.php: автозагрузка — PSR-4 автозагрузка

Смотри также (термины)

• Documentation — документирование проекта
• Legacy — работа с устаревшим кодом
• Refactoring — улучшение структуры
• Entry point — точка входа

Мини-FAQ

Онбординг только для джуниоров?

Ответ: Нет. Любой новый член команды (даже сеньор) проходит онбординг — ему нужно понять специфику проекта, процессы, архитектуру. Хороший онбординг важен для всех уровней.

Сколько должен длиться онбординг?

Ответ:

• Базовый (настроить окружение, сделать первый коммит): 1-3 дня
• Полный (самостоятельная работа): 2-4 недели
• Полная продуктивность: 1-3 месяца (зависит от сложности проекта)

Как улучшить онбординг в проекте?

Ответ:

1. Напишите README с быстрым стартом
2. Автоматизируйте настройку (Docker, скрипты)
3. Создайте чек-листы для каждого этапа
4. Назначайте ментора новым разработчикам
5. Собирайте фидбек и улучшайте процесс

Онбординг и документация — одно и то же?

Ответ: Нет. Документация — часть онбординга. Онбординг включает также менторство, практику, обратную связь, постепенное вовлечение в работу.