Browse Source

Update 'Лекции/Баг-репорт/Баг-репорт.md'

u22kolesnyak 3 months ago
parent
commit
b875d2c688
1 changed files with 13 additions and 22 deletions
  1. 13 22
      Лекции/Баг-репорт/Баг-репорт.md

+ 13 - 22
Лекции/Баг-репорт/Баг-репорт.md

@@ -16,23 +16,23 @@
 
 * Шаги воспроизведения - один из важнейших пунктов — пошаговая инструкция для воспроизведения проблемы. Четкие и структурированные шаги должны обеспечить воспроизведение проблемы любому человеку, даже тому, кто недавно присоединился к проекту. Пример:
 
-    *Откройте страницу регистрации (в идеале здесь еще нужно приложить прямую ссылку).
+    * Откройте страницу регистрации (в идеале здесь еще нужно приложить прямую ссылку).
 
-    *Заполните все обязательные поля.
+    * Заполните все обязательные поля.
 
     * Нажмите кнопку «Отправить».
 
 * Ожидаемый результат - здесь указываем, что должно было произойти. Пример: «Форма регистрации должна быть успешно отправлена, и пользователь должен получить сообщение о подтверждении».
 
-*Фактический результат - описание того, что произошло на самом деле. Пример: «Ничего не происходит, форма остаётся на той же странице, без сообщения об ошибке».
+* Фактический результат - описание того, что произошло на самом деле. Пример: «Ничего не происходит, форма остаётся на той же странице, без сообщения об ошибке».
 
-*Вложения - если проблема имеет визуальные проявления или сложна для описания, стоит приложить скриншоты, видео или логи. Это ускоряет понимание бага.
+* Вложения - если проблема имеет визуальные проявления или сложна для описания, стоит приложить скриншоты, видео или логи. Это ускоряет понимание бага.
 
-*Окружение воспроизведения бага - Очень важно указывать окружение, в котором был выявлен баг: версия ОС, браузер, устройство и т.д. Пример: «Windows 10, Microsoft Edge версия 130.0.2849.80». Иногда баги проявляются только на определённых конфигурациях.
+* Окружение воспроизведения бага - Очень важно указывать окружение, в котором был выявлен баг: версия ОС, браузер, устройство и т.д. Пример: «Windows 10, Microsoft Edge версия 130.0.2849.80». Иногда баги проявляются только на определённых конфигурациях.
 
-*Автор бага - да, многие заводят баги в системах управления задачами вроде Jira, где автоматически указывается автор, однако лучше указать это дополнительно.
+* Автор бага - да, многие заводят баги в системах управления задачами вроде Jira, где автоматически указывается автор, однако лучше указать это дополнительно.
 
-*Исполнитель - здесь необходимо указать разработчика, аналитика или другого специалиста, который будет ответственным за исправление данного недочета.
+* Исполнитель - здесь необходимо указать разработчика, аналитика или другого специалиста, который будет ответственным за исправление данного недочета.
 
 ## **Серьёзность и приоритет**
 
@@ -49,29 +49,20 @@
 
 *Скриншоты, видео, архивы запросов из devtools или логи ошибки. Может показаться, что вышеуказанной информации вполне достаточно для оформления баг-репорта, который поможет всей команде, однако не всё так просто.
 
-В результате небольшого опроса среди различных разработчиков и тестировщиков выяснилось, что 86,2% специалистов испытывают различного рода проблемы при работе с чужими баг-репортами.
-Результаты так же показали, что самыми важными аспектами баг-репортов для разработчиков, аналитиков и тестировщиков являются:
+Рассмотрим подробнее сложности, с которыми встречаются тестировщики повсеместно.
 
-    *шаги для воспроизведения – 86%;
-
-    *ожидаемый и фактический результаты – по 76%;
-
-    *описание проблемы – 73%.
-
-Результаты опроса полностью соответствуют действительности: при оформлении именно этих этапов баг-репорта тестировщики чаще всего испытывают трудности. Рассмотрим подробнее сложности, с которыми встречаются тестировщики повсеместно.
-
-*Пропуск шагов воспроизведения
+* Пропуск шагов воспроизведения
 Имеется ввиду не тот случай, когда специалист просто забыл написать какой-либо шаг (иногда такое тоже периодически случается). Здесь речь о том, что авторы баг-репортов порой намеренно не пишут о каком-либо действии для воспроизведения бага. Это происходит из-за того, что тестировщик, будучи хорошо погруженным в проект, не думает о том, что получатель репорта может быть новичком или по каким-то другим причинам не знать подробностей и нюансов возникновения подобных ошибок. Конечно, описывать излишне подробно тоже не стоит (например: сначала как отдельный шаг написать «Наведите курсор мыши на кнопку «Добавить», а уже следующим шагом «Нажмите на кнопку «Добавить»), главное – сообщить достаточное количество информации.
 
-*Неконкретное написание шагов воспроизведения
+* Неконкретное написание шагов воспроизведения
 Иногда бывает так, что автор баг-репорта описывает шаг, но не включает в него разного рода важные нюансы. Так, например, во фразе «Введите необходимое значение» из контекста сразу непонятно – а какое значение в данном случае является необходимым. Тут может быть два варианта решения проблемы. В первом случае нужно вместо слова «необходимое» использовать слово «валидное». Во втором – писать числовое значение, которое пользователь должен ввести (к примеру, «введите 10000»). Можно сказать, что некорректное написание шагов является следствием сложности, о которой говорилось в п.1 – когда автор не думает о том, что получатель отчета может не знать всей информации о проекте.
 
-*Сложные формулировки
+* Сложные формулировки
 Иногда авторы при написании баг-репорта используют очень длинные предложения, которые часто бывают логически не связаны между собой. Оборванные фразы, неуточненные предложения, отсутствие конкретики и сложносоставные конструкции в тексте репорта сильно усложняют его прочтение и, как следствие, увеличивают сроки для воспроизведения бага и устранения ошибки.
 
-*Непонятный заголовок.
+* Непонятный заголовок.
 Предположим, что мы участвуем в разработке корпоративного портала, где можно создавать различные заявки (отпуск, командировки, работа в выходные дни и т.д.), и у нас проблема в том, что не получается завести какую-то из них. В этом случае, если в заголовке просто написать «Не создается заявка», будет непонятно, какая именно заявка не создается и что конкретно нужно поправить\проверить.
-*Идеальное название баг-репорта должно отвечать на 3 главных вопроса: Что случилось? Где? И когда? (Например: «В личном кабинете сотрудника после нажатия на номер заявки не открывается карточка данной заявки»). Важно избегать абстрактных фраз, чтобы название сходу давало представление о проблеме.
+* Идеальное название баг-репорта должно отвечать на 3 главных вопроса: Что случилось? Где? И когда? (Например: «В личном кабинете сотрудника после нажатия на номер заявки не открывается карточка данной заявки»). Важно избегать абстрактных фраз, чтобы название сходу давало представление о проблеме.
 
 ## **Советы для составления качественного баг-репорта**