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

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

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

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

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

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

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

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

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

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

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