Буду также рад подписке на мой уютный telegram бложик: https://t.me/OlegMalyshevBlog
Название (заголовок) баг-репорта
- Название не должно быть слишком длинным
- Прочитав название должно быть сразу понятно в чем дело
- Принцип “Что? Где? Когда?
Плохой пример — “Если открыть вкладку crm, потом выбрать напоминания, потом мышкой нажать на чекбокс любого напоминания, то тогда не появится корзина”
Хороший пример — На вкладке crm в разделе напоминаний не появляется иконка удаления при проставление чек-бокса у любого напоминания
Плохой пример — “В заголовке письма не отображаются символы, при отправке письма”
Хороший пример — “В заголовке письма не отображаются русские символы при отправке письма Daily Stat (!!!
Вся суть в том, что нельзя отбрасывать те слова, которые имею значение, иначе разработчик не воспроизведет баг)
Шаги
Описываем все шаги, с упоминанием всех вводимых данных (явки, пароли) и промежуточных результатов
- Оптимально не более 7 шагов
- Минимально возможные шаги, выкидываем лишнее
- Добавляем пример, на котором воспроизводится баг, если это необходимо ( ссылка, файл, фотография и т д, именно те, с которыми вы поймали баг)
Плохой пример
1. Открыть браузер
2. Открыть jivo.ru
3. Войти в систему
4. Вести данные нашего админа
5. Теперь щелкнуть напоминания
6. В напоминаниях создать новую напоминалку
7. Нужно заполнить все нужные поля
8. Сохраняем
Хороший пример
1. Войти в jivo.ru : (логин: [email protected], пароль: 123456)
2. Перейти в Управление —-> CRM —-> Напоминания
4. Нажать на кнопку “Создать напоминание»
5. Заполнить поле “Описание” и “Дата” (Например: Test, 04.04.2023)
6. Нажать на кнопку “Сохранить”
Результат/Фактический результат
- Указываем кратко, что произошло и в каком состоянии находится система
- Прикладываем скриншоты, видео, логи (при грамотно составленном баге разработчику достаточно хорошего названия баг-репорта и скриншота/видео/логов)
Плохой пример
Результат: Кажется, напоминание не сохранилось и не создалось, но вообще должно было
Результат: Сохранение не работает корректно
Хороший пример
Результат: Появился попал с сообщением об успешном создании напоминания, но напоминание не появилось в списке
Ожидаемый результат
- В ожидаемом результате указываем по факту, что должно произойти
- Прикладываем скриншот ожидаемого результата.
- Помимо этого прикладываем доказательство, что результат должен быть такой, а не какой то другой
Что служит доказательством
- Спецификация
- Макеты
- Спросить у проджект менеджера, тим-лида, дизайнера, аналитика
- Ссылка на документацию, вики
- Здравый смысл
Плохой пример
Ожидаемый результат: Напоминание должно быть создано
Хороший пример
Ожидаемый результат: Появился попал с сообщением об успешном создании напоминания, созданное напоминание появилось в списке напоминаний
Приоритет/Серьезность
Приоритет (Priority) — это то насколько срочно надо исправить баг
Серьезность (Severity) — это то насколько баг влияет на нашу систему
Логи
Лог (с англ журнал) — это журнал, документ, в который программа вносит различные записи
Шаблоны оформления баг-репорта
Шаги
1. Раз
2. Два
3. Три
Результат
……………
Ожидаемый результат
……………
Шаги
1. Раз
2. Два
3. Три
ФР
……………
ОР
……………
Шаги
1. Раз
2. Два
3. Три
Фактический результат
……………
Ожидаемый результат
……………
Шаги
1. Раз
2. Два
3. Три
Что не так
……………
Как должно быть
……………