Опыт использования

Что приложить к баг-репорту, кроме слов «не работает»

Половина баг-репортов возвращается с вопросом «а что именно вы нажали». Разбираем, что приложить к отчёту, чтобы ошибка воспроизвелась с первого раза.

Коротко: отчёт работает, когда по нему можно повторить ошибку, не задавая вопросов. Для этого нужны три вещи: что вы делали, что ожидали увидеть и что увидели на самом деле. Скриншот закрывает третий пункт, запись экрана — сразу все три.

Почему «не работает кнопка» — плохой отчёт

Разработчик видит другое окружение: другой браузер, другой аккаунт, другие данные. Без подробностей он начинает с вопросов, и на выяснение уходит несколько часов переписки вместо десяти минут работы.

Что показать на скриншоте

  • Весь экран приложения, а не вырезанный фрагмент. По обрезанному кадру не понять, в каком разделе вы находились.
  • Адресную строку, если это веб-приложение: по ней видно и страницу, и параметры.
  • Текст ошибки целиком. Пересказ своими словами почти всегда теряет деталь, по которой её ищут в логах.
  • Стрелку или обводку на проблемном месте — иначе получатель будет искать его глазами.

Консоль браузера (F12, вкладка Console) и вкладка Network стоят отдельного снимка: там обычно видно, какой запрос упал и с каким кодом.

Когда нужна запись экрана

Скриншот показывает состояние, но не показывает путь. Запись нужна, если:

  • ошибка появляется только после нескольких действий подряд;
  • проблема в анимации, подвисании или порядке появления элементов;
  • сообщение об ошибке исчезает через пару секунд;
  • вы сами не уверены, какое именно действие приводит к сбою.

Короткая запись с голосовым пояснением заменяет абзац текста и снимает половину уточняющих вопросов.

Что добавить текстом

  1. Шаги. Пронумерованный список действий от входа в систему до момента сбоя.
  2. Ожидаемый и фактический результат. Две строки, но именно они отделяют ошибку от непонимания.
  3. Окружение. Браузер и его версия, операционная система, роль пользователя.
  4. Время. По нему находят нужный кусок логов.
  5. Воспроизводимость. Каждый раз или один раз из пяти — это разные задачи по сложности.

Почему ссылка удобнее вложения

Скриншоты и записи из чата теряются: через неделю задача открыта, а вложение уже где-то в истории переписки. Ссылка остаётся рабочей в карточке задачи, открывается без скачивания и не сжимается мессенджером — а значит, мелкий текст ошибки на ней остаётся читаемым.

Как получать такие ссылки автоматически — в разборе отправки скриншота ссылкой.

Короткие ответы

Что приложить к баг-репорту?

Скриншот с полным окном приложения и видимой адресной строкой, текст ошибки целиком, пронумерованные шаги воспроизведения, ожидаемый и фактический результат, а также браузер, систему и время. Если ошибка появляется после серии действий — короткую запись экрана.

Скриншот или запись экрана?

Скриншот показывает состояние, запись — путь к нему. Если ошибка возникает после нескольких действий, связана с анимацией или сообщение исчезает через пару секунд, нужна запись.

Нужно ли прикладывать консоль браузера?

Да, если приложение веб-based. Снимок вкладки Console и Network часто содержит упавший запрос и код ошибки — по ним проблему находят в логах за минуты.

Читать дальше