Спустя почти год наконец-то выходит второй пост рубрики #вопрос_ответ
Какой формат работы с git выбрать для ведения документации в парадигме docs as code?
На мой взгляд, самый подходящий формат работы в гите для документационных проектов небольших команд — github flow
Этот процесс подразумевает наличие одной основной ветки master и нескольких фиче-веток для каждой отдельной задачи.
Когда вам нужно что-то изменить в проекте, вы откалываете новую ветку от мастера, выполняете в ней работу и создаёте запрос на слияние (пул реквест в гитхабе или мерж реквест в гитлабе), в рамках которого ревьюер проверяет и согласовывает ваш текст, а потом выполняет этот запрос и вливает изменения в мастер-ветку, обновляя основную версию проекта.
Github flow хорошо подходит для небольших документационных проектов, которые поддерживаются несколькими людьми.
Несомненно ваш проект будет развиваться — процесс работы с гитом не отлит в граните, и вы можете адаптировать его под изменяющиеся реалии в вашей команде. Например, добавить еще одну основную ветку при появлении тестового стенда или настроить релизные ветки для интеграции обновления документации с продуктовыми релизами.
Кстати, на следующей неделе мы начинаем последний поток большого мастер-класса «Docs as code для ребят постарше», в рамках которого мы попробуем себя в роли тех.писателя небольшой документационной команды, поработаем с подходом github flow и создадим собственные док.проекты, которые можно использовать как портфолио или личную базу знаний.
Если хотите принять участие, пишите в личку @novillero, успевайте до выходных!
#карьера #практика