Як правильно описувати кроки в баг-репорті

Кроки відтворення – це інформація, яка необхідна для відтворення дефекту.

Кроки відтворення є дуже важливою інформацією в звіті. Після знаходження помилки у програмному забезпеченні, необхідно отримати точні кроки, при яких помилка повторюється. Важливо, щоб кроки були стабільними. Добре проаналізуйте ситуацію: які дані ви вносили в систему і в якій послідовності. У таких випадках добре допомагає запис відео.

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

Як правило, при описі кроків відтворення необхідно відповідати на питання: «Що необхідно зробити?», при цьому не вказувати особистих звертань.

Наприклад:

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

Наприклад:

Якщо дефект був знайдений після введення даних в якесь поле, тоді необхідно вказувати, які саме дані вводяться в поле. Приклади даних наводяться для більш точного проходження кроків та для скорочення кількості часу на відтворення дефекту.

Наприклад:

В останньому кроці необхідно вказувати, на яку область або блок з помилкою потрібно звернути увагу. Наприклад: «Look at the…», «Take a look at the…», «Pay attention to the…», «Звернути увагу на…». Щоб розробник зрозумів де саме знаходиться баг та на що потрібно звернути увагу після виконання усіх попередніх кроків відтворення.

Наприклад:

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

Наприклад:

Як правило, в баг-репортах описується мінімум 2 кроки, але не більше 7-8 кроків. Необхідно описувати кроки простими реченнями. Якщо немає можливості скоротити речення, тоді можна розбити його на кілька кроків.

Наприклад:

І навпаки – об'єднати кілька кроків в один для скорочення кількості кроків відтворення, в разі якщо це не призведе до втрати сенсу.

Наприклад:

Для більш точних кроків необхідно вказувати тип елемента, а не тільки назву елемента (наприклад: посилання, кнопка, логотип тощо). На сайті може бути декілька елементів з однаковими назвами, а вказівка типу елемента конкретизує опис. Це необхідно для того, щоб розробник розумів, на що саме потрібно натиснути або що обрати на цьому етапі та не втрачав час на пошук потрібного елементу.

Наприклад:

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