|
|
|
Это основная страница Wiki.
|
|
|
|
|
|
|
|
Создана из веб-интерфейса GitLab следуя путем наименьшего сопротивления.
|
|
|
|
Т.е. последовательно нажимая все кнопки по умолчанию.
|
|
|
|
|
|
|
|
Главная идея в том, чтобы на практике выяснить,
|
|
|
|
какой из способов ведения проектной документации более удобен.
|
|
|
|
|
|
|
|
Основной принцип в том, чтобы хранить документацию вместе с исходным кодом проекта.
|
|
|
|
Тогда больше вероятность, что она будет оставаться актуальной,
|
|
|
|
т.к. при изменении в код не так уж сложно обновить и документации.
|
|
|
|
Можно вообще это сделать в том же коммите, чтобы два раза не вставать.
|
|
|
|
|
|
|
|
|
|
|
|
Однако в случае Wiki документация хоть и хранится «рядом» с кодом,
|
|
|
|
в связанном с ним UI GitLab, но все же это отдельный репозиторий.
|
|
|
|
И значит, требует дополнительных действий, переключения контекста,
|
|
|
|
затрат сил и внимания, чтобы поддерживать его в актуальном состоянии.
|
|
|
|
Что увеличивает вероятность того, что про обновление документации разработчик
|
|
|
|
будет регулярно забывать.
|
|
|
|
|
|
|
|
Какие же плюсы есть у Wiki по сравнению с хранением документации в основном репозитории?
|
|
|
|
|
|
|
|
Главное преимущество — это возможность быстрой правки из веб-интерфейса.
|
|
|
|
Не нужно морочиться с клонированием репозитория, если это не твой основной проект.
|
|
|
|
|
|
|
|
Основное преимущество хранения документации вместе с кодом — одновременное обновление в одном коммите или MR/PR.
|
|
|
|
Меньше ментальных фрикций и нагрузки для автора кода и документации. |
|
|
|
\ No newline at end of file |