Перейти до вмісту

Запис архітектурного рішення

короткий запис рішення, причин і наслідків

Що це таке

Запис архітектурного рішення, або ADR від англійського architecture decision record, коротко пояснює важливий технічний вибір. У ньому зазначають, що ухвалила команда, за яких умов, які реальні альтернативи розглянула та з якими наслідками погодилася. Йдеться, наприклад, про відповідальність за набір даних, межі сервісів, спосіб інтеграції чи поведінку системи під час збою. Нова людина в команді зможе зрозуміти, чому рішення ухвалили та які припущення залишаються чинними.

Для корисного запису достатньо кількох полів. Ідентифікатор і дата полегшують посилання. Статус повідомляє, що рішення запропоноване, чинне або замінене іншим. Передумови описують проблему й конкретні обмеження. Саме рішення говорить, що втілюватиме команда. Наслідки охоплюють вигоди та обов’язки. Можливо, доведеться обслуговувати додатковий сервіс, довше переходити на нову версію або репетирувати міграцію. Опції слід описати настільки, щоб читач розумів, між чим обирали.

Запис має бути там, де його шукатимуть. Команда може тримати Markdown-файли поруч із кодом і посилатися на них зі змін, що втілюють рішення. Проєкт із кількома сховищами коду може вести спільний покажчик. Стабільна адреса й зрозуміле обґрунтування допомагають під час передачі роботи. Окремі звіти, тести та вимірювання варто прив’язувати посиланнями.

  • Розгорнутий блокнот на спіралі й чорна ручка на дерев'яній поверхні
    Фото: Engin_Akyurt / Pixabay
  • Ледь помітні лінії та чорна стрічка у відкритому блокноті крупним планом
    Фото: BRRT / Pixabay

Застосуйте поняття до рішення

Застосуйте «Що таке запис архітектурного рішення?» до конкретного рішення. Ми можемо пов'язати поняття із системою, яку ви створюєте або купуєте. Структура системи, спершу продумана на папері, щоб частини пасували одна до одної, а вартість була відома до першого рядка коду.

Переглянути наші послуги Зв'язатися з нами

Перевірте припущення за терміном

Використайте пояснення та пов'язані роботи, щоб сформулювати запитання для проєкту. Ми можемо перевірити припущення разом до вибору інструмента. Один інфраструктурний план для 14 підрозділів — 14 дослідницьких підрозділів, охоплених спільним інфраструктурним планом

Один інфраструктурний план для 14 підрозділів Зв'язатися з нами

Чому це важливо

Код добре показує, що існує зараз. Причини минулих рішень у ньому видно частково. Нова колега може помітити дві бази даних і запропонувати об’єднати їх. Поділ міг бути тимчасовою межею ризику, поки постачальник змінював формат експорту. Запис може пояснити, що команда захищала, чому обрала такий спосіб і яка подія змусить переглянути рішення. З кожною зміною складу команди не доведеться повторювати все дослідження.

Запис дає змогу заперечити предметно. Пропозиція нового компонента може позбавити команду потреби писати планувальник. Водночас чергова людина матиме відновлювати стан компонента після збою. Колега може запитати, чи вона матиме доступ і скільки роботи додасть відновлення. Обґрунтування стає доступним експлуатаційній команді до затвердження. Після нього нові відповідальні бачать, про що домовилися.

Витрати часу на пояснення залежать від ціни перегляду. Новий напис на кнопці зазвичай легко пояснити в історії зміни. Передача права власності на реєстр замовлень або інший захист від подвійних оплат зачіпає кілька сервісів. Такі рішення варто описувати, поки команда пам’ятає альтернативи та доступні на той час дані. Датоване посилання допомагає відтворити саме тодішню ситуацію.

Як це виглядає на практиці

У портфоліо описано початкові технічні рішення для платформи, де вибір ключових технологій супроводжував формування продукту. Це приклад вибору, який варто вміти пояснити згодом. Наступний вигаданий сценарій показує, як можна зафіксувати рішення про відповідальність за дані.

Служба доставки має базу замовлень і публічну сторінку для перевірки їхнього стану. Частина подій надходить пізно. Водночас сторінка не має розкривати замовлення іншого покупця. Команда обирає окрему модель читання, до якої надходять лише дозволені поля. Прямий запит до реєстру потребував би менше компонентів і зазвичай давав би свіжіші дані. Він також наблизив би публічний трафік і новий контроль доступу до основного реєстру. Повторне використання нічного експорту спростило б роботу, проте приховало б події поточного дня.

Наслідки перетворюються на завдання. Підтримці потрібна ознака затримки, щоб вона могла перейти до внутрішньої процедури. Контрактна перевірка може помітити випадково додане поле. За оновленням і сповіщенням закріплюють відповідального. Рішення переглянуть, якщо затримка перевищить узгоджену межу протягом двох завантажених тижнів або зміниться вимога відокремлення. Посилання на обговорення й перевірку залишаються в записі.

Коли нове рішення замінить старе, потрібен окремий запис із посиланнями в обох напрямках. Причини попереднього вибору важливі для людей, які досліджують стару версію. Невеликий покажчик із датами й статусами підказує, який запис чинний сьогодні.

Публічна служба перевіряє, чи має відвідувач доступ до конкретного замовлення, перш ніж повернути стан. Перевірте відмову в доступі до чужого замовлення та точний набір полів у дозволеній відповіді.

Де виникають проблеми

Запис слабшає, якщо команда докладно пояснила єдиний бажаний варіант, а інші описала так, що їх ніхто не обрав би. Наведіть найкращі реальні аргументи кожної можливості. Для важливих тверджень укажіть замір, норму чи умову, що вплинула на вибір. Коли умови зміняться, читач зрозуміє, чому може змінитися висновок.

Ще одна помилка — записати користь без ціни та відповідального. Додаткова база чи спільна черга змінює робочий день іншого підрозділу. Визначте, хто супроводжує систему, перевіряє доступ і оновлює документацію. Коли наслідок ще неможливо перевірити, запишіть майбутнє спостереження та момент, коли воно стане доступним.

Пишіть достатньо стисло, щоб запис з’явився ще під час ухвалення. Операційні процедури можуть існувати окремо й змінюватися частіше. Потім, коли потрібне інше рішення, обидва обґрунтування залишаться доступними, а читач знайде чинний варіант за датою, статусом і посиланням.

У записі також можна вказати, хто має право погодити виняток. У прикладі з відправленням особлива ручна операція іноді потребуватиме доступу до реєстру. Команда може обмежити такий доступ метою і строком, узгодити відповідального й перевірити в журналі, що після роботи доступ закрили. Завдяки цьому тимчасовий виняток не змінює рішення мовчки, а новий учасник бачить його чинні межі.

Що почитати далі

Словник

Обирайте за фактичними умовами

Опишіть робочий процес, наявні інтерфейси та користувачів, яким потрібна зміна. Ми можемо визначити перевірюваний результат і спосіб передачі, який дасть вашій команді змогу підтримувати його.

Дивитися, скільки це коштує Зв'язатися з нами

Зробіть термінологію практичною

Запитайте, як «Що таке запис архітектурного рішення?» стосується вашої організації. Конкретного прикладу з поточної системи достатньо для початку розмови.

Переглянути наші послуги
welcome@engineer.company +45 50 10 61 84 Копенгаген, Данія
QR-код сторінки «Запис архітектурного рішення»
Візьміть цю сторінку із собоюhttps://engineer.company/uk/glossary/architecture-decision-record/