Як написати англійською мовою безглуздої інциденту Timeline

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

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

** Запис з датою і часом ** — один рядок на часовій шкалі, який прикріплено до певного часу, у якому вказано, що було спостерігано або зроблено, записано так, щоб він міг бути самостійним, без потреби у навколишньому оповіданні для контексту. “Кожен запис з часом має бути читабельним самостійно: ‘14:32 UTC — рівень помилок на службі замовлення перевищує 5%, пожежі попередження’ говорить про повний факт, не вимагаючи від читача вже знати історію.”

** Системно-фокусована фраза ** - описує те, що зробила система, а не те, що зробила людина, коли поведінка системи є фактичним фактом, який записується, що переміщує речення від натяку на те, що людина спричинила результат. “Замість написання «інженер розгорнув погану конфігурацію», системно-фокусована фраза буде звучати так: «зміна конфігурації була розгорнута о 14:20 UTC, що вилучило обмеження повторних спроб» — факт збережений, рамкування не про помилку людини.”

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

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

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

• “У [час], [система] почала виявляти [специфічну спостережувану поведінку].”
• «Зміна була впроваджена в [час] того [спеціфічного фактичного ефекту], який, як ми тепер розуміємо, вніс свій внесок в інцидент»
• “Проміжок часу між першим спостережуваним симптомом і початком попередження був [тривалість].”
• «Кілька факторів, що сприяли цьому інциденту, об’єдналися; жоден з них сам по собі не міг би викликати повний вплив»
• «Ця хронологія відображає те, що було спостерігабельним в кожній точці, а не те, що було відомо або повинно було бути відомо в той час»

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

Запис дії без її позначення як помилки:

• “14: 20 UTC — Зміна налаштувань, яка вилучає обмеження повторних спроб запитів, була розгорнута у виробничому середовищі як частина запланованого випуску. Ця зміна не була позначена існуючими автоматичними перевірками.”*

Описуючи виявлення чесно, включаючи прогалини:

• “14: 32 UTC — Попередження про частоту помилок для checkout- service, 22 хвилини після появи перших підвищених журналів помилок. Поріг попередження вимагав п’ять послідовних хвилин вище 5%, що затримувало виявлення. ”*

Список факторів, що впливають на рейтинг без покарання: “Цей інцидент мав три фактори: зміна обмеження повторних спроб, прогалина в виявленні, спричинена вимогою тривалого порогу попередження, і застарілий підручник з ескалації, який вказував на застарілій ротації на виклику.”

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

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

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

1. Переписати речення « Інженер забуває оновити налаштування », використовуючи системно- орієнтовану фразу.
2. Написати запис з часовим штампом, який описує проміжок часу виявлення у 15 хвилин без посилання на причину затримки.
3. Перелік трьох факторів, що спричинили гіпотетичний відключення бази даних, уникаючи однієї « кореневої причини ».

Національна мова — мова, що використовується для спілкування ненаціональних груп

Створення безвинної хронології інциденту має вирішальне значення, але конкретна мова, яку ми використовуємо, може значно вплинути на її ефективність - особливо для розробників, чия перша мова не є англійською. Це не просто передати * те, що * сталося; це зробити це з ясністю і точністю, очікуваною в професійному спілкуванні. Поширеною пасткою є використання надмірно сильних або судових фраз, навіть ненавмисно. Наприклад, замість того, щоб сказати « Джон неправильно реалізував функцію », більш нейтральним підходом буде « Реалізація відхилялася від документованих специфікацій ». Такий тонкий зсув уникає приписування вини, але все одно чітко сформулює проблему. Аналогічно, такі фрази, як «він зіпсував розгортання» є сповнені негативних конотацій і не сприяють розумінню кореневої причини.

Ключовим елементом є зосередження на спостережуваних діях і їх наслідках. Замість « Система зламалася, тому що він не перевіряв її », краще було б написати: « Після розгортання системи моніторингу вказували на несподіване збільшення кількості помилок, що призвело до переривання роботи у [часовий знак ]. » Зауважте, що у цій версії дані — рівень помилок — ставиться вище суб’ єктивних інтерпретацій про те, * чому * це сталося. Крім того, послідовне використання активного голосу зміцнює ваш письмовий стиль і зменшує неоднозначність. Пасивні конструкції, такі як «Проблема була визначена командою», можуть затемнити відповідальність. Активний голос, наприклад, «Команда визначила проблему», є більш прямим і прозорим.

Іншою областю, на якій варто зосередитися, є словник, пов’язаний з технічними процесами. Такі терміни, як «вадка», «дефект» або «неуспіх» можуть мати різні конотації залежно від культурного контексту. У безвинному постморті, загалом краще описати події як «неочікувана поведінка», «відхилення від очікуваної продуктивності», або «проблема, що вимагає уваги», а не відразу позначити її як «ваду». Це дозволяє більш об’єктивне обговорення обставин без передчасного призначення відповідальності. Пам’ятайте, мета не в тому, щоб визначити помилку; це зрозуміти як щось пішло не так, щоб ви могли запобігти цьому знову.

Нарешті, при написанні описів для повідомлень Slack або оновлень PR, пов’ язаних з хронологією подій, пам’ ятайте про короткість і ясність. Довгі, заплутані речення схильні до неправильного тлумачення. Спробуйте зробити короткі висновки, які чітко описують зроблені кроки і зроблені спостереження. Просте повідомлення на кшталт: « Дослідження високої затримки в службі X після розгортання — моніторинг показує пік о 14: 30 UTC » є набагато ефективнішим, ніж нерозбірливе пояснення, наповнене припущеннями. Сфокусуйтеся на спостережуваних фактах, використовуйте точну технічну мову, де це необхідно, і надайте пріоритет чіткій комунікації над усім іншим.