Docs-as-code на максималках. Часть 4: Workflow и обратная совместимость
Цикл "Docs-as-code на максималках": Фундамент: Архитектура и видение проекта Публикация: Пайплайн Markdown → Confluence Рабочее место: Obsidian как IDE для аналитика Правила игры: Workflow и обратная совместимость ← вы здесь AI-агент: На пути к вайбаналитингу У нас уже есть движок публикации и настроенный GUI-редактор.
Теперь обсудим рабочий флоу аналитика в новом окружении и как организовать переезд из Confluence, никого и ничего не поломав.Первый же вопрос, который встает при командной работе в репозитории: как сделать, чтобы изменения по двум разным задачам не пересекались по файлам и не плодили конфликты на мерже.Ответ - продуманная структура, где у каждой описываемой части системы есть свое место.Мы потратили на согласование структуры достаточно много времени и остановились на следующем подходе:Архитектура системы/ — обзор, структура приложений, модули, ER-диаграммы (только критичные участки), модель данных по модулям, миграции данных, права доступаВнешние системы/ — системы, с которыми интегрируется продукт; на каждую описание + сервисы (на каждую ручку REST отдельный файл)Внешний API/ — слой сервисов, которые отдает наша система; методы сгруппированы по endpoint, на каждую ручку отдельный .mdПроцессы/ — пользовательские пути, решающие бизнес-задачу; как правило, связаны с эпиком 1-к-1.
habr.com