Як пояснити обмеження ставки для нетехнічних зацікавлених сторін
Практичний посібник англійською мовою для пояснення обмеження швидкості API для нетехнічних зацікавлених сторін — аналогії, бізнес-формування і відповіді на поширені відгуки.
Обмеження швидкості - це концепція, яку інженери приймають за звичайну, але пояснення її менеджеру продукту, керівнику успіху клієнта або керівнику вимагає перекладу технічної безпеки з точки зору досвіду клієнта і бізнес-ризика. Погані пояснення призводять до розчарування учасників, які сприймають обмеження швидкості лише як « щось, що блокує нашого клієнта ». У цьому підручнику ви знайдете словниковий запас і фрази, які допоможуть вам чітко пояснити обмеження швидкості англійською мовою.
Ключовий словник
** Обмеження швидкості ** — обмеження кількості запитів, які клієнт може надати API за певний проміжок часу. “Наша обмеженість швидкості — 100 запитів на хвилину на ключ API — якщо ви перевищите цю межу, наступні запити буде відхилено доки вікно не буде скинуто.”
** Обмеження швидкості ** — сповільнення або відхилення надмірних запитів після досягнення обмеження швидкості, замість їх негайної обробки. “Коли клієнт перевищує обмеження, ми обмежуємо його запити, а не призводимо до аварійної роботи служби — замість перевищення часу очікування він отримує повідомлення про помилку.”
** Код стану 429 (Забагато запитів) ** — стандартний код відповіді HTTP, який повертається, коли клієнт перевищив обмеження швидкості.
- “Клієнтам слід сприймати відповідь 429 як сигнал до сповільнення і повторення спроби після вказаного часу очікування, а не як помилку.” *
** Дозволена швидкість розгортання ** — тимчасовий допуск на короткі піки, які перевищують звичайне обмеження швидкості, перед тим, як буде впроваджено заходи з примусового виконання.
- “Ми дозволяємо надходження 20 додаткових запитів протягом десяти секунд, тому короткий пік від пакетного завдання клієнта не буде відразу відхилено.” *
** Справедливе використання ** — принцип, що обмеження швидкості існують для того, щоб жоден клієнт не міг погіршити обслуговування для всіх інших. “Обмеження швидкості не стосується обмеження будь-якого клієнта несправедливо - це стосується справедливого використання, так що пік трафіку одного клієнта не сповільнює платформу для всіх.”
** Backoff strategy ** — підхід, за якого клієнт чекає і повторює спроби після обмеження швидкості, зазвичай збільшуючи час очікування між повторними спробами.
- “Ми рекомендуємо клієнтам реалізувати експоненційну стратегію відмови, чекаючи поступово більше часу між повторними спробами замість негайного повторення.” *
** Квота ** — довгострокове обмеження, часто щоденне або щомісячне, відмінне від короткострокового обмеження швидкості, яке обмежує загальне використання за довший період часу. “Крім обмеження на рівень за хвилину, корпоративні клієнти мають щомісячну квоту 10 мільйонів запитів, включених у їх план.”
** Обмеження ступеневої ставки** — різні пороги обмеження ставки, застосовані на основі плану або рівня договору клієнта. “Ми пропонуємо ступеневі обмеження швидкості — безкоштовні клієнти отримують 60 запитів на хвилину, а корпоративні клієнти отримують 1000.”
Пояснення «чому» для зацікавлених сторін
- “Ограничение скорости защищает платформу для всех. Без цього, один неправильно налаштований скрипт клієнта може сповільнити сервіс для всіх наших інших користувачів»
- «Передумайте це як спільну дорогу — обмеження швидкості є правилами дорожнього руху, які зберігають всіх у руху, а не один автомобіль, що рухається так швидко, як він хоче, і викликає затори для всіх інших»
- «Це не покарання для клієнта — це захист. Коли вони досягають межі, це зазвичай знак того, що їх інтеграція повторюється занадто агресивно, і ми можемо допомогти їм це виправити»
Відповідь на Pushback від команди, що стикається з клієнтом
- «Я розумію, що клієнт розчарований, але повне вилучення обмеження швидкості для них ризикує погіршити досвід для кожного іншого клієнта на тій же інфраструктурі»
- «Ми можемо запропонувати вищий рівень замість повного зняття обмеження — це дає їм більше простору для маневру без зняття сітки безпеки»
- «Погляньмо на їхню фактичну схему використання спочатку — часто, проблема обмеження швидкості насправді є багом логіки повторних спроб на стороні клієнта, який виправлення вирішить без необхідності більшого обмеження взагалі»
Використовується для визначення і обчислення коефіцієнтів
- «У нас є три варіанти: підвищити їх обмеження, допомогти їм оптимізувати свою інтеграцію, щоб використовувати менше запитів, або пересунути їх на план, розроблений для їхнього рівня використання»
- «Збільшення обмеження для одного клієнта можливе, але я хочу позначити компроміс — він використовує спільну інфраструктурну потужність, яка впливає на інших клієнтів також»
- «Найчистіший виправлення тут на їхньому боці — реалізація стратегії відступу — але ми також можемо підвищити їхню надбавку за вибух як зупинка»
Професійні поради
- ** Використовуйте аналогію спільного ресурсу, а не лише технічні терміни. ** Порівняння обмежень швидкості з правилами руху або спільною чергою допомагає нетехнічним учасникам швидко зрозуміти аргумент справедливості.
- ** Переформулюйте “блокований” як “захищений”. ** Команди, що працюють з клієнтами, краще реагують на “це захищає якість обслуговування для всіх”, ніж на “це блокує надлишкові запити”
- ** Надати конкретні альтернативи замість простого відхилення запитів. ** Порівняльний план або інтеграційний виправлення надають зацікавленим сторонам щось, що можна використати для повернення клієнту.
Практичні вправи
- Поясніть обмеження швидкості нетехнічним колегам, у 3- 4 реченнях, використовуючи аналогію, а не технічні терміни.
- Написати відповідь менеджеру з успішного обслуговування клієнтів з проханням повністю вилучити обмеження швидкості для розчарованого клієнта.
- Напишіть коротке повідомлення з трьома варіантами поведінки з клієнтом, який постійно перевищує обмеження швидкості.
«Слово» — слово, що використовується для позначення мови
Будьмо чесними. Пояснення технічних концепцій, таких як обмеження швидкості, комусь, хто не є розробником, може бути… незручним. Ви хочете, щоб вони зрозуміли * чому * це важливо, а не просто почули купу жаргону. Ключовим елементом є використання точної мови і оформлення проблеми в умовах, які вони розуміють - зосереджуючись на впливі бізнесу, а не на механіці. Однією з поширених пасток для не-рідних англомовних носіїв є за замовчуванням надто технічні описи, коли існують простіші альтернативи.
Наприклад, замість того, щоб сказати «Ми реалізуємо обмеження швидкості запитів на основі нашої політики обмеження API», ви можете сказати: «Щоб забезпечити надійний сервіс для всіх наших користувачів, ми встановили захисні заходи, щоб запобігти надмірному використанню API. Це означає, що якщо хтось надсилає занадто багато запитів за короткий проміжок часу, система тимчасово сповільнить його доступ до системи. Зауважте, наскільки яскравіше і менш залякувальним є це словосполучення. Цей підхід уникає таких термінів, як «політика обмеження», яка може звучати бюрократично або складно без контексту.
Інша область, на якій варто зосередитися, це передбачення спільного відсічу. Зацікавлені сторони часто реагують негативно, коли вони сприймають обмеження, навіть якщо це з хорошої причини. Фрази на кшталт «Ми обмежуємо доступ» можуть бути інтерпретовані як відмова в обслуговуванні. Замість цього спробуйте « Щоб забезпечити справедливе використання і запобігти зловживанню » або « Це захищає нашу систему від перевантаження ». Коли хтось запитає: « А як щодо * наших * користувачів? », ви можете відповісти: « Це справедлива занепокоєність. Це обмеження допомагає нам підтримувати постійний досвід для всіх, запобігаючи невеликій кількості користувачів впливати на службу для інших»
Нарешті, під час перегляду коду або написання описів PR, пов’ язаних з обмеженням швидкості, пам’ ятайте про вибір слів. Замість « API відхилить запити, які перевищують X », скористайтеся « Система тимчасово призупине обробку вхідних запитів, якщо їх кількість перевищить визначене обмеження ». Цей варіант є більш прямим і уникає можливих плутанин у термінології. Пам’ятайте, ясність і фокусування на результаті - надійність, стабільність і справедливе використання - є ключем до успішного спілкування. Не бійтеся пояснити «чому» так само, як і «що»