Всем привет! Меня зовут Катя, я СPO Gramax. Выражу популярное мнение: вести любую командную доку в ворде — тупо и неудобно. Как и в любой системе, где нет понятного механизма версионирования. Версионирование нужно для того, чтобы:

  • Отслеживать, как менялся док.

  • Кто его менял.

  • Как менял.

  • Возвращаться к предыдущей версии.

  • Объединять версии.

Как бы в базах знаний над этим не мучались, круче чем в Git этого нигде нет. И если вы считаете, что практики разработки сложно и долго изучаются, сейчас попытаюсь убедить в обратном.

Команды Git

Любую команду в Git можно сопоставить с действием над черновиком или чистовиком документа. Эту тему уже несколько раз раскрывали адепты Docs as Code. Например, за основу я взяла статью на хабре (https://habr.com/ru/articles/456410/). Итак, начнем.

Последняя утвержденная версия → Главная ветка (Master)

В Git, эталонная и наиболее стабильная версия вашего проекта хранится в главной ветке, аналогично вашему финальному или утвержденному документу. По сути это чистовик.

Копирование файла → Создание ветки (Branching)

Когда вы хотите внести изменения в документ, не трогая оригинал, вместо копирования файла, вы создаете новую «ветку» в Git. Это черновик.

Копирование последних изменений к себе → Pull/Fetch

Если над документом в одной ветке работает несколько человек, их изменения не нужно вручную переносить в свою версию. Для этого используются команды  git pull  или  git fetch . Вы буквально говорите: забери из этой ветки изменения других людей.

Сохранение изменений → Commit

Пока ваши изменения не опубликованы, их можете просматривать только вы. Чтобы коллеги смогли оценить проделанную работу, нужно ее сначала зафиксировать — для этого делаете  commit .

Публикация → Git Push

Чтобы опубликовать свой документ на сайт, используете  git push . Также команда может использоваться для сохранения работы на удаленный сервер. Например, если публичного сайта нет, но расшарить док на команду нужно.

Проверка → Pull Requests

Когда черновик готов к публикации, его нужно согласовать с коллегами или руководителем. Чтобы не делать это в мессенджере или по почте, в Git используется  pull request . В нем проверяющий видит, что конкретно поменялось. И принимает решение: подтвердить изменения или отклонить.

Копирование текста в конечный файл → Слияние (Merge)

После завершения работы над изменениями, вместо копирования и вставки измененного текста из черновика в чистовик, вы объединяете ветки в Git.

Сравнение редакций → Git Diff

Чтобы увидеть различия между версиями документов, вместо ручного сравнения, вы используете команду  git diff .

Как работать с командами

Все команды не обязательно выполнять в консоли. Можно делать это через любую IDE или специальное приложение по типу Fork.

В Gramax мы перетащили все эти команды в интерфейс, чтобы даже нетехнические специалисты могли быстро разобраться. Наши базовые понятия можно узнать тут.