Технічна англійська: бути зрозумілим, а не просто почутим

Практичні поради для не-носіїв англійської мови в IT щодо написання чітких тікетів, стендапів і коментарів коду, які насправді читають.

Більшість технічних непорозумінь на роботі мають мало спільного з граматикою. Тікет прочитають невірно, повідомлення в Slack ігнорують, апдейт зі стендапу залишає всіх в розгубленості щодо того, що насправді сталося. Якщо ви працювали в командах безпеки чи розробки з людьми з десятка різних країн, ви вже знаєте, що справжня навичка — не вільне володіння, а точність під тиском часу.

Чому граматика не є вузьким місцем

Носії мови пишуть заплутані тікети постійно. Проблема зазвичай у структурі, не в словнику. Повідомлення на кшталт "API знову ненормально себе поводить, можливо, пов'язано з тим, що було вчора" не спрацює незалежно від акценту чи оцінки граматики. Порівняйте з: "POST /users/create повертає 500 з 14:02 UTC. Почалося після вчорашнього розгортання (commit a3f9c1). Логи додані." Друга версія спрацьовує, тому що вона одразу наводить факт, дає мітку часу й називає припущувану причину. Будь-хто, хто це читає, в будь-якому часовому поясі, знає, що робити далі.

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

Три структури речень, які покривають 90% робочого письма

Більшість технічної комунікації вміщується в три моделі:

Твердження + доказ — "Endpoint входу часто не працює. Частота помилок становить 3% за останню годину, всі 502s, всі з us-east-1."
Запитання + обмеження — "Можете переглянути зміну правила брандмауера до 4 годин дня? Вона блокує розгортання."
Рішення + причина — "Ми повертаємося до v2.3.1. Новий rate limiter видаляє легітимний трафік."

Запам'ятайте ці структури, і ви зможете писати майже все, що потрібно стендапу, тікету або постмортему, не звертаючись до складного словникового запасу. Складний словниковий запас — це зазвичай місце, де не-носії мови витрачають час і впевненість — шукаючи

Написано з допомогою штучного інтелекту, перевірено та опубліковано Мішалем Пільчем (CISSP), Korra Studio.