У нашій постійній рубриці «QA поради новачкам» хвилююча для всіх тестувальників тема: опис багів англійською мовою з використанням passive voice.

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

Баги англійською мовою так само, як і будь-які інші, мають ряд атрибутів, для кожного з яких існують правила і поради з написання. Далі в статті будуть розглянуті поради і правила для всіх основних атрибутів баг-репорта.

1. Тема/Summary

Тема баг-репорта англійською мовою повинна бути складена за правилом «Що? Де? Коли?». Це сприятиме розумінню проблеми одразу після прочитання теми. Проте в англійській мові це правило є скоріше похідним від граматично правильного порядку слів у реченнях.

У загальному випадку, в українській мові гнучка система відмінків дозволяє використовувати незакріплений порядок слів у реченні:

«Джима б'є Біллі»

або

«Біллі б'є Джима»

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

«Jim hits Billy.» (Джим б'є Біллі.)

«Billy hits Jim.» (Біллі б'є Джима.)

В англійській мові речення містять твердий порядок слів.

Твердий порядок слів має велике значення в сучасній англійській мові, оскільки через погано представлену морфологічну систему мови, члени речення часто виділяються тільки своїм місцем у реченні.

Зазвичай порядок слів в англійському реченні наступний:

  • Підмет займає перше місце;
  • далі йде Присудок;
  • потім Доповнення;
  • і, нарешті, Обставина.

Аналогічно складанню речень англійською мовою в загальному випадку працюють правила і для складання атрибутів баг-репорта (в тому числі і теми).

Однак, крім правильного порядку слів, слід також пам'ятати про те, що в англійській мові існують активний (хтось робить дію) і пасивний (над кимось/чимось відбувається дія) стани. Оскільки підметом в темі найчастіше є якась сутність або предмет, у більшості випадків для опису теми слід використовувати пасивний стан (Passive voice).

Слід зауважити, що дієслова «present», «appear», «absent», «occur» не варто використовувати в пасивному стані, їх краще замінити на «show» або «display».

Наприклад:

Картка пацієнта не зберігається в базі пацієнтів після натискання кнопки «Save».

Неправильний варіант Правильний варіант
Неправильний варіант

The patient’s card is not saving in the patient database after clicking the «Save» button.

Правильний варіант

The patient’s card is not saved in the patient database after clicking the «Save» button.

У наведеному прикладі картка пацієнта (підмет) є неживим предметом (сутністю), яка не робить дію збереження самостійно, але дія збереження відбувається над нею якимось користувачем, який для нас не є важливим.

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

З іншого боку, існує варіант написання теми в активному стані, проте його використання вкрай небажане, оскільки, якщо слідувати загальним правилам створення баг-репортів, безособистісний опис проблеми є пріоритетним.

Наприклад, в українській мові замість

Користувачеві не відображається сторінка введення електронної пошти після натискання на кнопку «Restore password»

слід писати

Сторінка введення електронної пошти не відображається після натискання на кнопку «Restore password»

Аналогічно для англійської мови слід використовувати безособистісний опис, якому відповідала б окрема форма – пасивний стан.

Окремо варто наголосити на необхідність правильного використання артиклів «a», «an» і «the» в реченнях. Артикль – це частина мови, якої немає в українській мові. Ми міняємо наголос і порядок слів, щоб надати фразі відтінок, а в англійській порядок слів строго фіксований.

Подивіться як змінюється зміст фрази:

Мені подобається машина.

Машина мені подобається.

У першому випадку незрозуміло, про яку машину йде мова, а в другому мова йде про конкретну машину. В англійській мові не можна міняти слова місцями, тому, щоб надати потрібний відтінок фразі, використовуються артиклі A, An і The.

Поняття артикля в граматиці англійської мови пов'язане з категорією визначеності. Спрощено, правило артиклів звучить так:

Якщо говоримо про невідомий предмет, то використовуємо невизначений артикль A/An. Якщо мова йде про щось певне, то перед ним ставиться артикль The.

Артикль The походить від This (це) можна пальцем вказати. A/An походить від One (один). Ось чому артикль A/An вживається тільки в однині. На практиці артикль The використовується досить часто, так як при описі помилки необхідно конкретизувати, що саме сталося, назвати конкретну кнопку, вказати на конкретний блок на сторінці, або ж конкретну сторінку, вказуючи назву.

Наприклад:

Неправильний варіант Правильний варіант
Неправильний варіант

A «Submit» button is not displayed on an «Registration» page

Правильний варіант

The «Submit» button is not displayed on the «Registration» page

 2. Опис/Description

Як відомо із загальних правил складання баг-репортів, його опис (description) є допоміжним полем, яке має відповідати темі і, якщо необхідно, уточнювати її, однак при цьому залишатися досить коротким. Опис, на відміну від теми, може складатися з 1-2 речень. В описі баг-репортів англійською мовою теж слід пам'ятати про правильний порядок слів у реченні і використання пасивного стану, оскільки додаючи більше даних до інформації з теми бага початківці-тестувальники часто «збивають» правильний порядок, побудований в темі.

3. Кроки/Steps to reproduce

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

При написанні кроків в баг-репортах англійською мовою основною проблемою для початківців-тестувальників є неправильне використання сталих виразів. Досить часто тестувальники, які до цього заводили баг-репорти українською або російською мовою, намагаються перенести свій досвід і використовувані конструкції в англійську мову, внаслідок чого з'являються перекладені дослівно конструкції.

Наприклад, в українській мові прийнятно писати дві конструкції:

Натиснути кнопку «Enter»

або

Натиснути на кнопку «Enter»

В англійській же мові тільки зазначені конструкції є правильними: 

Неправильний варіант Правильний варіант
Неправильний варіант

Click at/to the «Save» button

Правильний варіант

Click (on) the «Save» button

Аналогічно і для інших форм даного дієслова:

Неправильний варіант Правильний варіант
Неправильний варіант

...after clicking at/to the «Home» link

Правильний варіант

...after clicking the «Home» link

4. Очікуваний і фактичний результати/Expected and actual results

Очікуваний і фактичний результати описуються за тими ж правилами, що і тема звіту про помилку. Однак, якщо фактичний результат може збігатися з Summary (хоча це небажано, і потрібно намагатися описати баг більш докладно), то в очікуваному потрібно детально описати, як насправді повинна вести себе програма. В даному випадку також потрібно дотримуватися правила написання речення в пасиві та використання правильних артиклів.

Наприклад:

Неправильний варіант Правильний варіант
Неправильний варіант

Actual result: The Patient’s card is not saving (or does not save) in patient database after clicking the «Save» button

Expected result: The Patient’s card saves in patient database on clicking the «Save» button.
(Картка пацієнта зберігає в базі даних пацієнтів після натискання на кнопку «Зберегти»)

Правильний варіант

Actual result: The Patient’s card is not saved in the patient database after clicking the «Save» button

Expected result: The Patient’s card is saved in the patient database after clicking the «Save» button.
(Картка пацієнта зберігається в базі даних пацієнтів після натискання кнопки «Зберегти»)

Після написання баг-репорта будь-якою мовою, вдалою практикою, особливо для тестувальників-початківців, буде повернутися та перевірити все, що описувалося вище. Правильне використання зворотів, артиклів, пасиву або ж банальна помилка – їх обов'язково потрібно виправити. Чистий та правильно оформлений звіт свідчить про сумлінність та професіоналізм тестувальника!

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