Архитектурное ревью

Артефакты

Шаблон описания тут.

  • функциональные требования
    • зачем нужен сервис, какую задачу решаем
  • нефункциональные требования
    • нагрузка
    • доступность
    • время отклика
  • компонентная диаграмма
    • компоненты системы
    • миддлваре - БД/кеши/очереди
    • информационные потоки
  • описание компонент - зачем они нужны/специфика взаимодействия
  • гипотезы Набор предположений и ограничений, на которые опирается тех дизайн
  • структура работ Перечисление смежных команд, вовлеченных в доработку. Для каждой команды нужно описание, зачем она нужна
  • процессная модель Архитектурно значимые Use-Case’ы, расписанные в моделях взаимодействия сервисов между собой.

Регламент

Архитектурное ревью нужно проводить в следующих случаях

  • квартальное планирование, для инициатив входящих в квартальный комит в процессе квартального планирования команда делает оценку и формирует роадмап, базируясь на технической архитектуре
  • долги с квартального планирования если команда не дотащила архитектуру в квартальное планирование/есть открытые вопросы, команда дотаскивает долги в процессе
  • вброс крупной доработки в команду в течении квартала Если в команду в течении квартала залетела новая фича
  • крупные слеты если в процессе реализации тех дизайн доказал свою несостоятельность. В этом случае делаем и представляем новый тех дизайн

Участники

  • обязательные
    • архитектор
    • тех лид команды
    • представители смежных команд
      • если <команда играет существенную роль в архитектуре> AND <если команда ранее таких вещей с смежной командой не делала>
    • явно приглашенные эксперты
  • необязательные
    • прочие участники юнита
    • представители горизонталей (если условие выше не выполнено)

Инициация

  • выложить артефакты на страницу в конфле
  • закинуть встречу в календарь
    • встречу может назначить тех лид
      • до встречи нужно валидировать идею и качество артефактов
    • к встрече приложить Артефакты
    • при необходимости позвать приглашенных экспертов
  • провести встречу
  • обновить страницу в конфле - выложить результаты/замечания

Результаты

В результате арх ревью может быть

  • принято - тех дизайн принят без существенных замечаний
    • в этом случае можно двигаться вперед
  • частично принято - тех дизайн принят, но есть замечания
    • в этом случае нужно исправить замечания и в оффлайне прислать исправления на участников встречи
    • в случае необходимости повторяем встречу
  • есть существенные замечания
    • нужно исправить существенные замечания и повторить арх ревью в том же составе

By [alex]