Баг-репорт по записи экрана с голосом: действия, ожидаемый и фактический результат
Из видео ошибки соберите условия, последовательность действий, ожидаемый результат и наблюдаемый результат. Причину сбоя указывайте только как гипотезу, если она не установлена.
Почему «на видео всё видно» мало
Разработчику нужно воспроизвести сбой. Запись может начинаться с уже открытого экрана, а важное действие происходило до неё. В тексте должно быть понятно, какие исходные условия известны и какие пропущены.
Расшифровка видео сохраняет пояснения пользователя. Её сверяют с экраном: слова «нажимаю сохранить» и фактическое нажатие могут относиться к разным моментам.
Как составить проверяемое описание
Опишите среду
Запишите название и версию приложения, устройство и роль пользователя, если они известны. Не угадывайте версию по внешнему виду экрана.
Восстановите шаги
Начните с исходного состояния и перечислите минимальные действия. Если предварительное условие не попало в кадр, запросите его вместо выдуманного шага.
Разделите ожидание и наблюдение
Укажите, на чём основано ожидание: согласованное требование или обычный пользовательский сценарий. Фактический результат опишите без предположения о внутреннем устройстве системы.
Проверьте воспроизведение
Если повторная попытка разрешена и безопасна, пройдите собственные шаги. Не выдавайте единичный показ за стабильную ошибку; отметьте число наблюдавшихся попыток.
Учебный пример: наблюдение отдельно от причины
Ниже — вымышленный учебный пример. Он показывает способ оформления, а не рекомендации преподавателя или историю реального клиента.
Заполнил форму, нажал сохранить, а название в списке осталось прежним. Наверное, база не обновилась.
Подтверждено только то, что в показанном списке осталось прежнее название. Причина «база не обновилась» не установлена. Проверка может потребовать повторного открытия записи или уточнения, какой список показан.
Сохраните таймкод нажатия и результата. Перед передачей записи уберите из рабочей копии ненужные личные данные и секреты; право доступа к исходнику согласуйте с командой.
| Часть | Рабочая формулировка | Не делать |
|---|---|---|
| Условия | Открыта форма редактирования | Угадать версию |
| Шаги | Изменить название, сохранить | Пропустить начальное состояние |
| Результат | В списке прежнее название | Назвать причину доказанной |
| Проверка | Повторяемость ещё не установлена | Написать «всегда» |
Заготовка: баг-репорт
Заведите отдельную запись на один материал. Заполняйте только то, что подтверждается источником; открытые вопросы оставляйте видимыми.
Короткое название проблемы: Среда и версия: Предварительные условия: Шаги воспроизведения: Ожидаемый результат и основание: Фактический результат: Таймкоды / рабочая копия видео: Повторяемость: Что ещё неизвестно:
Что сверить перед использованием
- Шаги начинаются до сбоя
- Ожидание имеет основание
- Наблюдение не подменено диагнозом
- В передаваемой копии проверены данные
Разберём детали
Нужно ли переписывать всю речь?
Нет. Полная расшифровка остаётся источником, а баг-репорт содержит шаги и результат.
Если ошибку не удалось повторить?
Так и укажите. Сохраните условия исходной записи и различия повторной попытки.
Что делать с действием за кадром?
Отметьте пробел и задайте вопрос автору. Не вставляйте предполагаемый шаг как факт.