# Как использовать Handbook

# Почему пишется handbook

Для распределенной команды очень важно быстро и эффективно делиться знаниями и обмениваться информацией.

# Как вносить изменения

# Редактирование через GitLab

У каждой страницы внизу есть ссылка на редактирование. Она ведет на GitLab, где можно прямо в вебинтерфейсе внести правки. Желательно выгрузить копию репозитория себе и оформляйть изменения в виде Merge Request'ов.

# Редактирование через локальный репозиторий

  1. Склонируйте репозиторий с проектом.
  2. Загрузите обновления git pull.
  3. Создайте ветку git checkout -b update-some-page.
  4. Внесите изменения.
  5. Закомиттье git commit -a -m "update some page".
  6. Отправьте в gitlab git push origin update-some-page.
  7. Оформите Merge Request.

# Форматирование

Для форматирования используется Markdown.

# Рекомендации по оформлению:

  • Если на странице больше 4х подзаголовков, добавьте блок с содержанием. Для этого вставьте макрос [[toc]] в начале страницы:
# Главный заголовок
[[toc]]

# Рекомендации по стилю

  • Избегайте корпоративного языка. Представьте, что пишите другу.
  • Объясняйте на примерах.