Когда я работала техническим писателем в международной команде, bug reports частенько попадались мне на глаза. И довольно быстро стало понятно: 90% багов написаны одними и теми же конструкциями, просто в разном порядке. Ниже - концентрат того, что часто используется в bug reports на английском. Сохраняйте.
1. Title/Summary - самая суть проблемы
Хороший заголовок отвечает на три вопроса:
Where? - где произошла проблема;
What? - что именно случилось;
When/Under what conditions? - при каких условиях.
Что используется
Present Simple
Активный или пассивный залог
Иногда вообще без глагола
Часто опускаются артикли для экономии пространства и времени
Примеры
Пример на английском |
Перевод на русский |
Что используется и почему |
Application crashes on startup |
Приложение падает при запуске |
Present Simple - описывает постоянное поведение системы. Обратите внимание, что "при запуске" - это "ON startup". Нужный предлог не всегда приходит на ум. |
Error message is displayed on form submission |
Сообщение об ошибке отображается при отправке формы |
Passive Voice — важен результат (сообщение появляется), а не тот, кто его вызвал. |
Login form validation error |
Ошибка валидации формы логина. |
Составные существительные в заголовке, однажды я подробно рассказывала о них в этой статье. |
Быстрое пояснение, как отличать Пассивный залог (Passive Voice) от Активного (Active Voice):
Активный залог используется, когда важно кто выполняет действие или действие пользователя.
Пример: The user clicks the Submit button - Пользователь нажимает кнопку Submit.
Чаще всего актив используется в: Steps to Reproduce (Шаги для воспроизведения), User actions (действия пользователя).Пассивный залог (Passive voice) используется, когда важен результат, а не исполнитель.
Пример: The request is rejected by the system - Запрос отклоняется системой.
Чаще всего используется в: Expected result (Ожидаемый результат), Actual result (Фактический результат), Summary.
2. Environment - где именно всё сломалось
Уверена, что вы и без меня знаете, что здесь указываются:
OS & version
Browser & version
App version
Test environment (staging, prod)
Здесь у меня только одно напоминание: «операционная система» — это operating system (а не operation). Если хотите написать сокращенно, то помещаем «OS» после названия операционной системы, а не наоборот. Пример: Linux OS, Windows OS.
3. Preconditions — при каких условиях появляется баг
Здесь описывается состояние системы до начала шагов.
Что используется
Present Simple
Часто Passive voice
Примеры
User is logged in - Пользователь авторизован.
User has admin permissions - У пользователя есть права администратора.
Notifications are enabled - Уведомления включены.
4. Steps to Reproduce — пошаговая инструкция
Важно максимально точно расписать шаги, чтобы разработчик смог воспроизвести их, не задавая лишних вопросов.
Что используется
Imperative (повелительное наклонение). И не нужно лишние "you" или "should/must".
Active voice
Примеры
1. Log in with valid credentials. — Войдите с корректными данными.
2. Click ’Dashboard’. — Нажмите «Dashboard».
3. Observe the blank page. — Вы увидите пустую страницу.
А еще делюсь самыми частыми глаголами, которые используются в bug reports.
Для Desktop (простые "select" и "click" уже знакомы, так ведь?):
Глагол |
Пример |
Double-click sth - дважды щелкнуть по чему-либо |
Double-click the file to open it - Дважды щелкните по файлу, чтобы открыть его. |
Right-click sth - щелкнуть правой кнопкой мыши по чему-либо |
Right-click the folder and then click Properties - Щелкните правой кнопкой мыши по папке и нажмите Свойства. |
Hover the mouse pointer over sth - навести указатель мыши на что-либо |
Hover the mouse pointer over the icon - Наведите указатель мыши на иконку. |
Click/select the check box - установите флажок |
Select the Header row check box. |
Clear the check box - снимите флажок |
Clear the Header row check box. |
Для мобильных устройств:
Глагол |
Пример |
Tap something – коснуться чего-либо (экрана, иконки и др.) |
To open an app, simply tap its icon on the screen – Чтобы открыть приложение, просто коснитесь его иконки на экране. |
Double-tap something – дважды коснитесь чего-либо |
Double-tap the image to zoom in – Дважды коснитесь изображения, чтобы увеличить его. |
Pan something – сдвигать, прокручивать, перетаскивать |
Pan across the map by dragging your finger in the desired direction – Прокручивайте карту, проводя пальцем в нужном направлении. |
Pinch, stretch to zoom – уменьшить или растянуть, чтобы изменить масштаб |
Pinch two fingers together to zoom out on an image or stretch them apart to zoom in – Сведите пальцы вместе, чтобы уменьшить масштаб изображения, или разведите их в стороны, чтобы увеличить масштаб. |
Tap and hold something -коснитесь и удерживайте что-либо |
Tap and hold an app icon to move it to a different location on the screen – Коснитесь и удерживайте иконку приложения, чтобы переместить его в другое место на экране. |
5. Expected result - ожидаемое поведение системы
Что используется
Модальный глагол "should"
Часто passive voice
Примеры
The form should be submitted successfully - Форма должна успешно отправляться.
The user should be redirected to the dashboard - Пользователь должен быть перенаправлен на дашборд.
Customers should land on the home page of the Application. - Клиенты должны иметь возможность перехода на главную страницу системы.
На самом деле в bug reports может встречаться не только "should". Смотрим на ситуации:
Модальный глагол |
Когда используется |
Пример |
Must/ have to |
Для критичных требований или обязательных шагов |
The user must be logged in to access this page - Пользователь должен войти в систему, чтобы получить доступ к этой странице. |
Should |
Для ожидаемого поведения системы |
The page should display the total amount correctly - Страница должна корректно отображать общую сумму. |
Can/ could |
Для описания возможностей или обходных путей |
You could try refreshing to see if it resolves - Вы могли бы попробовать обновить, чтобы проверить, поможет ли это. |
May/ might |
Для описания вероятности |
The error might appear intermittently - Ошибка может возникать периодически. |
6. Actual result - что происходит на самом деле
Что используется
Present Simple
Часто отрицание и Passive voice
Примеры
The form is not submitted - Форма не отправляется.
The page does not load - Страница не загружается.
Вам точно пригодятся шаблоны для описания ошибок на английском:
Шаблон |
Пример |
An error message is displayed instead of… - Вместо … отображается сообщение об ошибке. |
An error message is displayed instead of the confirmation screen - Вместо экрана подтверждения отображается сообщение об ошибке. |
The issue occurs when the user tries to... - Проблема возникает, когда пользователь пытается... |
The issue occurs when the user tries to upload a file larger than 10 MB - Проблема возникает, когда пользователь пытается загрузить файл больше 10 МБ. |
An error occurred when/while (doing something) – Возникла ошибка при… |
An error occurred when connecting to the service - Возникла ошибка при подключении к сервису. |
An error comes up when/while (doing something) – Возникает ошибка при… |
An error comes up when applying the changes - Возникает ошибка при применении изменений. |
An exception is thrown when/while (doing something) – Возникло исключение при… |
An exception is thrown when trying to update the app - Возникло исключение при попытке обновить приложение. |
Nothing happens when… - Ничего не происходит при... |
Nothing happens when clicking the Submit button - Ничего не происходит при нажатии кнопки Submit. |
Обратите внимание, что после "when", "while" используется герундий (verb + -ing), если вы хотите сказать "при каком-либо действии".
Если вы используете "during", то после него должно быть существительное, а не герундий. Например, Unexpected behavior is observed during checkout (Во время оформления заказа наблюдается некорректное поведение).
Прикреплённые логи, скриншоты и видео тоже должны сопровождаться пояснениями. Например, такими:
See the attached logs for more information. - См. логи во вложении для более подробной информации.
See the attached screenshot of the error page. - Cм. скриншот ошибки во вложении.
***
А теперь вы, коллеги: расскажите в комментариях, что еще важно учесть, чтобы написать понятный и никого не раздражающий bug report на английском. Особенно интересно послушать международный опыт.
Еще больше подборок и лайфхаков для облегчения жизни тестировщиков в международной команде - на моём Телеграм-канале, заглядывайте!
AdrianoVisoccini
bug report
да, да. I must be fun at parties