Превратите Запись в Отчет, По Которому Можно Действовать
Загрузите запись экрана с ошибкой. Воспроизведите ее, и каждый раз, когда происходит что-то важное, отмечайте это. Отметка времени фиксируется, кадр из видео захватывается в этот момент, и шаг попадает в нумерованный список.
Напишите резюме, что вы ожидали и что произошло вместо этого, затем скопируйте все это в виде Markdown для GitHub, разметки Jira или обычного текста. Данные о браузере и экране уже заполнены.
Запись никогда не покидает вашу машину. Она воспроизводится из локального файла, и кадры отображаются на вашем устройстве, что важно, когда ошибка находится в невыпущенной сборке или в учетной записи клиента.
Почему Этот Инструмент Не Использует ИИ для Написания Отчета
Модель, наблюдающая за записью экрана, может описать, что она видит. Она не может знать, что вы ожидали увидеть, а это та часть отчета об ошибке, которая определяет, сможет ли кто-либо действовать по ней.
«Нажал «Подтвердить», панель счета была пуста» - это наблюдение. Является ли это ошибкой, полностью зависит от того, что должно было там появиться, и единственный человек, который это знает, - это вы. Инструмент, генерирующий ожидаемое поведение из видео, угадывает и представляет эту догадку как обнаружение, что хуже, чем оставлять поле пустым, потому что правдоподобное неверное ожидание направляет разработчика по неверному пути.
Поэтому разделение здесь преднамеренное. Инструмент выполняет механическую работу, которую он может сделать точно: отметки времени, кадры, окружение, форматирование, нумерация. Вы предоставляете суждение. Это занимает около минуты, и в результате получается отчет, по которому вам никто не будет задавать вопросов.
Три Вещи, Которые Отчеты Обычно Упускают
Прочитав множество неполных отчетов об ошибках, я заметил, что одни и те же пробелы повторяются, и все три являются скорее механическими, чем сложными.
Отметки времени. Отчет, который гласит «смотрите прикрепленное видео», заставляет читателя просматривать четыре минуты, чтобы найти нужный момент. Шаг, который указывает, что это произошло в 1:12, этого не требует.
Окружение. Браузер, операционная система, размер экрана. Все знают, что это нужно включать, но почти никто этого не делает, потому что это означает открытие панели настроек, пока вы погружены в мысли. Здесь это считывается из вашего браузера и уже заполнено в отчете, и вы можете это исправить.
Кадры. Кадр в момент сбоя - это то, что сканируется в списке из двадцати проблем. Извлекать кадры из видео вручную достаточно утомительно, чтобы люди пропускали это, поэтому это происходит автоматически на каждом шаге, который вы отмечаете.
Что Именно Захватывается
Каждый отмеченный шаг записывает точное время воспроизведения и кадр JPEG из видео в этот момент, масштабированный для сохранения легковесности отчета. Вы можете скачать кадры, чтобы прикрепить их к проблеме.
Окружение поступает из браузера: его название и версия, операционная система, размер экрана с его пиксельным соотношением и размер области просмотра. Браузеры теперь сообщают о себе меньше, чем раньше, поэтому некоторые данные могут быть неизвестны, и каждое поле является редактируемым, а не заблокированным.
Ничего не выводится из пикселей. Инструмент не пытается считывать текст ошибки с экрана или угадывать, на какой элемент вы нажали, потому что делать это ненадежно хуже, чем не делать этого вообще.
Структура, Которую Он Заполняет
Вывод следует форме, которая установилась для отчетов об ошибках, потому что системы отслеживания и люди, читающие их, этого ожидают. Если вы искали шаблон отчета об ошибке, то это тот, который приходит уже заполненным, а не тот, который вы вставляете и рассматриваете.
Сначала краткое изложение, в одной строке, потому что эта строка - то, что кто-то сканирует в списке из тридцати проблем, и она решает, будет ли ваша открыта сегодня.
Затем нумерованные шаги с тайм-кодом на каждом, ожидаемое поведение, фактическое поведение и окружение. Этот порядок - не украшение. Читатель проверяет шаги, чтобы увидеть, воспроизводима ли ошибка, пару «ожидаемое/фактическое» - чтобы понять, действительно ли это ошибка, и окружение - чтобы определить, относится ли она к его системе. Скрытие любой из этих деталей приводит к дополнительным уточнениям.
Чего пустой шаблон не может сделать, так это заполниться сам, и это та часть, из-за которой люди пропускают его. Здесь шаги, тайм-коды, кадры и окружение заполнены, а вы пишете три поля, которые инструмент действительно не может знать.
Перед записью
Отчет настолько хорош, насколько хороша запись, и два правила делают разницу.
Начинайте с известного состояния. Запись, которая начинается в середине сеанса, оставляет читателя гадать, что было раньше, поэтому шаги перестают быть воспроизводимыми. Начинайте с экрана входа, новой страницы или описанной отправной точки.
Очистите экран от всего, что не должно быть передано. Токены в адресной строке, имя клиента, несвязанное электронное письмо в другой вкладке, ключ API в панели разработчика. Отчет об ошибке пересылается, вставляется в чат и читается людьми вне команды, и запись экрана содержит все, что было на экране в тот момент. Этот инструмент никогда не загружает видео, но отчет и кадры отправляются туда, куда вы их отправляете.
Что он не делает
Он не создает задачу. Нет подключения к GitHub, Jira или чему-либо еще; вы копируете отчет и вставляете его туда, куда он относится, что также означает, что вы можете прочитать его раньше, чем кто-либо другой.
Он не захватывает логи, сетевые запросы или вывод консоли. Все это находится в ваших инструментах разработчика и имеет огромное значение для некоторых ошибок. Прикрепляйте их с помощью любого безопасного маршрута, который уже использует ваша команда, вместо того чтобы снимать консоль.
И он ничего не диагностирует. Он не скажет вам причину, какой компонент виноват, или является ли это дубликатом существующей проблемы. Он приводит доказательства в форму, с которой кто-то может работать, и это вся его работа.
Запись ошибки в первую очередь
Если вам все еще нужно зафиксировать проблему, запись экрана записывает вкладку, окно или весь дисплей в браузере. Для ошибки, которую вам нужно озвучить во время воспроизведения, записывайте с аудио, и объяснение останется прикрепленным к доказательствам.
Два полезных соседних инструмента. Если вы хотите отдельные изображения, а не отчет, извлекатель видеокадров извлекает кадры через интервалы. И если запись длинная, и вы хотите получить голосовую инструкцию в виде текста, генератор стенограмм превращает повествование в нечто, что можно искать.
