Як написати Feature Flag Rollout Plan англійською мовою

План розгортання, який просто каже «ми будемо розгортати його поступово» не дає команді нічого робити, коли щось не так о 2 годині ранку - хороший план називає етапи, конкретну метрику, яка викликає паузу, і хто відповідає за рішення на кожному кроці.

Ключовий словник

** Фаза розгортання ** — визначений відсоток або сегмент трафіку (внутрішні користувачі, 5%, 25%, 100%), до якого буде поступово розширено прапорець можливості, кожен етап буде виконувати роль контрольної точки перед подальшим розширенням. “Перший етап розгортання є тільки для внутрішніх співробітників, протягом 24 годин - це дає нам вікно з низьким ризиком, щоб вловити щось очевидне, перш ніж справжні користувачі побачать це.”

** Тригер відновлення ** — певна, заздалегідь визначена умова (поріг частоти помилок, регресія затримки, певне попередження), якщо ця умова буде виконано, прапорець буде негайно вимкнено, і вам не слід буде обговорювати його знову. “Нашим тригером відновлення є подвійне збільшення частоти помилок на кінцевій точці отримання, що триває п’ять хвилин — якщо це трапляється, хто б не був на зв’ язку, негайно вимикає прапорець, без необхідності підтвердження.”

** Kill switch ** — механізм (зазвичай, сам прапорець можливості), який дозволяє миттєво вимкнути можливість без розгортання коду, у цьому полягає суть блокування ризикованих змін за допомогою прапорця замість їхнього безпосереднього надсилання. “Оскільки це за прапорцем, у нас є перемикач зупинки — якщо щось не так на будь- якій стадії розгортання, ми відключаємо його за кілька секунд, замість того, щоб потребувати екстреного розгортання.”

** Метрика захисту** — метрика, за якою спостерігають під час розгортання, зокрема, для виявлення небажаних побічних ефектів, відмінних від метрики, яку функціональність має поліпшити, оскільки функціональність може досягти своєї мети, тим часом спокійно порушуючи щось інше. “Швидкість конвертації є метрикою, яку ми намагаємося поліпшити, але час завантаження сторінки є нашою метрикою захисту — ми стежимо, щоб нова функція не тихо не уповільнювала сторінку для всіх.”

Звичайні фрази

• Що таке цей фільм, і хто його зняв?» (англ. What is this movie?
• «Як довго ми печемо на кожному етапі розгортання, перш ніж розширюватися?»
• Чи є в цьому щось дивне, чи це просто гра, яку потрібно перевірити?»
• «Що таке метричний рівень захисту тут, відокремлений від метричної оцінки успіху функції?»
• «Хто має право приймати рішення про перехід на наступний етап?»

Приклади висловлювань

Відкриття документа плану розгортання:

• “Цей план передбачає впровадження нового потоку отримання за прапорцем new-checkout. Ми пройдемо через чотири етапи — внутрішні користувачі, 5%, 25%, 100% — з мінімальним 24-годинним часом випічки на кожному етапі перед продовженням»

Визначення тригера відновлення:

• “Тригер відновлення: якщо частота помилок під час отримання перевищує 1% (базовий рівень — 0, 2%) протягом більше ніж п’ яти хвилин на будь- якій стадії, інженер-подарунок негайно вимикає прапорець і публікує повідомлення в #incidents — для цього тригера не потрібне схвалення.” *

Пояснення параметрів захисних огорож для зацікавлених сторін: *“Ми відстежуємо конверсію замовлення як метрику успіху, але ми також спостерігаємо за часом завантаження сторінки і обсягом квитків на підтримку як загородженнями - функція може поліпшити конверсію, повільно погіршуючи щось інше, і ми хочемо вловити це рано, а не після повного розгортання.” *

Професійні поради

• Визначте кожен етап ** розгортання ** з певним відсотком або сегментом і мінімальним часом витримки — « поступове розгортання » без цифр не дає жодних конкретних даних, які можна було б перевірити.
• Написати ** тригер відновлення ** як конкретну, вимірювану умову, а не “якщо щось виглядає неправильно” - нечіткі тригери вимагають судження під тиском, що саме тоді, коли люди найгірше їх роблять.
• Явно вкажіть, що ** kill switch ** не потребує підтвердження для використання під час активного інциденту — вимога виходу для вимикання прапора знищує всю мету його існування.
• Назвіть принаймні одну ** метрику захисту **, яка відрізняється від метрики успіху можливості — інакше розгортання може виглядати як перемога на папері, але завдати шкоди, на яку ніхто не дивиться.

Практичні вправи

1. Написати тригер відновлення для гіпотетичного розгортання можливостей, включаючи певний поріг.
2. Поясніть різницю між метрикою успіху і метрикою захисту.
3. Опишемо етапи розгортання, які ви визначили б для помірно ризикованої можливості.

Національні мови: мова оригіналу: англійська

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

Часто виникає проблема при описі * тригера відновлення *. Просто сказати «якщо це не вдасться» недостатньо. Замість цього вам слід вказати конкретні умови, за яких буде активовано повернення. Наприклад, хорошим описом може бути: « Розгортання буде автоматично відновлено, якщо рівень помилок у межах цільового сегмента перевищуватиме 5% протягом 15 хвилин поспіль, за даними нашої системи моніторингу ». Зауважте використання кількісних показників — « 5% », « 15 хвилин поспіль » — які додають конкретних деталей і зменшують неоднозначність. Аналогічно, під час опису етапів, уникайте нечітких термінів, таких як « продовжити » або « рухатися вперед ». Використовуйте більш описові дієслова: « перехід до наступної фази », « розпочати цільове видання » або « розширити розгортання на основі спостереженої продуктивності »

Розгляньте, як ви оформляєте запити під час перегляду коду. Отримавши зворотній зв’язок, наприклад, «Це потребує вдосконалення», можна відчувати себе неоднозначно. Кращий підхід був би такий: «Чи можете ви, будь ласка, пояснити критерії для визначення успіху в цьому сегменті? Зокрема, чи ми прагнемо досягти X% прийняття за Y часовий проміжок? “Це демонструє активний і спільний підхід, показуючи, що ви шукаєте * конкретні * рекомендації, а не просто приймаючи загальну критику. Іншою корисною фразою є «Давайте забезпечимо вирівнювання» при обговоренні планів розгортання з зацікавленими сторонами - це підкреслює необхідність того, щоб всі були на одній сторінці щодо цілей і очікувань.

Нарешті, зверніть увагу на активний проти пасивного голосу. У той час як пасивний голос іноді може бути відповідним у технічній документації (наприклад, «Флаг функції був розгорнутий»), в комунікації * про * розгортання, активний голос зазвичай призводить до яснішого і більш прямого повідомлення. Замість того, щоб сказати « Розгортання буде контролюватися », краще сказати « Наша команда буде контролювати розгортання ». Це підкреслює відповідальність і володіння, ключовий аспект професійного співробітництва.