Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • D docs-vs-wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Jira
    • Jira
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Terraform modules
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Andrey Esipenko
  • docs-vs-wiki
  • Wiki
  • Home

Home · Changes

Page history
Create home authored Jul 22, 2022 by Andrey Esipenko's avatar Andrey Esipenko
Hide whitespace changes
Inline Side-by-side
home.md 0 → 100644
View page @ 66b1891a
Это основная страница Wiki.
Создана из веб-интерфейса GitLab следуя путем наименьшего сопротивления.
Т.е. последовательно нажимая все кнопки по умолчанию.
Главная идея в том, чтобы на практике выяснить,
какой из способов ведения проектной документации более удобен.
Основной принцип в том, чтобы хранить документацию вместе с исходным кодом проекта.
Тогда больше вероятность, что она будет оставаться актуальной,
т.к. при изменении в код не так уж сложно обновить и документации.
Можно вообще это сделать в том же коммите, чтобы два раза не вставать.
Однако в случае Wiki документация хоть и хранится «рядом» с кодом,
в связанном с ним UI GitLab, но все же это отдельный репозиторий.
И значит, требует дополнительных действий, переключения контекста,
затрат сил и внимания, чтобы поддерживать его в актуальном состоянии.
Что увеличивает вероятность того, что про обновление документации разработчик
будет регулярно забывать.
Какие же плюсы есть у Wiki по сравнению с хранением документации в основном репозитории?
Главное преимущество — это возможность быстрой правки из веб-интерфейса.
Не нужно морочиться с клонированием репозитория, если это не твой основной проект.
Основное преимущество хранения документации вместе с кодом — одновременное обновление в одном коммите или MR/PR.
Меньше ментальных фрикций и нагрузки для автора кода и документации.
\ No newline at end of file
Clone repository
  • Home