Як написати докладний звіт про помилки англійською мовою

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

Мова опису в англійській мові — англійська

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

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

Стандартна структура

Кожне ефективне звітування про ваду має таку структуру:

Title: [Component] Brief description of what is wrong

** Неправильна назва: ** Login broken ** Хороший заголовок: ** [Auth] Login form submits successfully but redirects to /dashboard 404 on Safari 17

---

Шість секцій

** 1. Резюме** Одне речення. Что пошло не так? Будьте конкретними щодо того, яка функція, яка була неочікувана поведінка, і (якщо відомо) за яких умов.

• « Ел. пошту для скасування пароля не буде надіслано, якщо адреса користувача містить знак плюс (+) ». *

** 2. Екологія

Процитовано 2017-02-17.  Safari 12.2 Площа 14,3 га Версія 3.0.1 (commit a1b2c3d ) Розмір екрана: 1440px

** 3. Репродукція (Reproduction) Список з нумерацією. Кожен крок має бути однією дією.

1. Європа Перейти до /forgot-password 2-й. Введіть адресу електронної пошти з символом +, наприклад, user+tag@example.com 3-й. Натисніть ** Надіслати посилання для скасування** 4-й. Перевірити теки « Вхідні » і « Спам »

** 4. Очікуваний результат**

Електронну пошту зі звітом про скасування пароля слід надіслати на вказану адресу протягом 30 секунд.

** 5. Фактичний результат**

Електронної пошти не отримано. У інтерфейсі користувача буде показано « Надіслано електронну пошту » без повідомлення про помилку. Журнали сервера показують помилку 422 від служби електронної пошти.

** 6. Серйозність/Пріоритет**

** Серйозність: ** Висока — впливає на всіх користувачів, які використовують адреси зі знаком плюс ** Пріоритет: ** P2 — типовий шаблон електронної пошти, який використовують досвідчені користувачі для фільтрування

---

Основний словник

Term	Meaning in context
to reproduce	To make the bug happen again following the same steps
intermittent	Happens only sometimes, not consistently: “The crash is intermittent — occurs roughly 1 in 5 attempts”
edge case	An unusual or extreme input that triggers unexpected behaviour
regression	A bug introduced by a recent code change that broke something that previously worked
blocker	A bug that prevents the team from proceeding with testing or release
flaky	A test or behaviour that passes and fails unpredictably
to triage	To assess bugs by severity/priority and decide what to fix first

---

Корисні фрази для звітів про вади

Описати, чого ви очікували:

• “Очевидна поведінка… ”
• • “Згідно з критеріями специфікації / прийняття, система повинна…” *
• • « Раніше (до версії X) це працювало правильно. » *

** Опис фактичної поведінки: **

• “Натомість, система…”
• “Страниця показує помилку 500.”
• • « Кнопка не відповідає / вимкнено / відсутня ». *

Вираз непевності:

• “Це може бути пов’язано з останніми змінами в…”
• “Я не зміг відтворити це послідовно — це здається, що це переривчасте.”
• “Невідомо, чи це стосується тільки Safari, чи впливає на інші браузери.”

** Додавання долучень: **

• • « Будь ласка, перегляньте долучений знімок екрану / запис екрана / файл журналу. » *
• • « Підписана стеком трасування наведено нижче. » *

---

Швидкий перевірковий список перед надсиланням

• Чи може розробник, який ніколи не бачив цю функцію, відтворити її за допомогою ваших кроків?
• Чи є заголовок достатньо конкретним, щоб його було можливо знайти у системі стеження?
• Чи ви вказали точний номер версії/збірки?
• Чи очікуваний результат вказати явно (а не просто « це має спрацювати »)?
• Чи долучили ви докази (знімок вікна, журнал, відео)?

Звіт, який пройде цей перевірковий список, буде виправлено. Один, який не буде, буде сидіти в затримці тижнями — або буде закритий як «не може відтворювати»

Національна мова: англійська, мова мовців індіанських мов, що не є офіційною мовою штату

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

Однією з найчастіших проблем є використання надто буквальних перекладів. Наприклад, безпосередній переклад «Це порушує функціональність» на іншу мову може звучати незграбно і неясно. Замість цього, намагайтеся використовувати такі фрази, як «Це заважає очікуваній поведінці», або «Програма не виконується так, як було заплановано». Аналогічно, замість того, щоб сказати «Я бачу тут ваду», розгляньте «Я виявив проблему, яка потребує уваги» – це звучить більш формально і демонструє активний підхід. Зверніть особливу увагу на дієслова з часовими формами; використання теперішнього часу (« є пошкодженим ») іноді може вказувати на постійний стан, коли ви маєте на увазі тимчасовий стан. Минулий час («було пошкоджено») часто є більш точним при описі впливу помилки. Крім того, пам’ятайте про порядок слів - структура англійського речення значно відрізняється від багатьох інших мов.

Іншою областю, на якій варто зосередитися, є рівень деталізації. Хоча спокусливо спрощувати пояснення для ясності, надмірне спрощення може призвести до неоднозначності. Наприклад, якщо ви повідомляєте про проблему у описі запитів на звантаження, не просто скажіть « Кнопка не працює ». Замість цього вкажіть контекст: « Натискання кнопки « Надіслати » на сторінці профілю користувача не призведе до жодної дії і виведе на екран помилку переглядача (NetworkError 404) — див. долучений знімок вікна ». Такий рівень деталізації дозволяє переглядачам швидко зрозуміти проблему, відтворити її самостійно і запропонувати рішення. Пам’ятайте, ви не просто описуєте що сталося; ви надаєте інформацію, яка дозволяє комусь іншому виправити це.

І нарешті, не вагайтеся попросити про пояснення або відгук на ваші твори. Швидке повідомлення Slack на зразок « Чи можете ви, будь ласка, переглянути опис цього звіту про помилку? Я хотів переконатися, що кроки для відтворення чітко описані» демонструє бажання навчатися і вдосконалювати свої комунікаційні навички - щось високо цінується в будь-якій команді розробників. Багато людей, для яких англійська мова є рідною, оцінять активний підхід, і вони можуть запропонувати вам цінний взірець фраз і термінології, який може бути особливо ефективним у контексті вашого конкретного проекту. Пам’ятайте, чітке спілкування - це двостороння дорога.