Как с помощью Loom записывать понятные отчеты о багах

Создание понятных и эффективных отчетов об багах с помощью Loom

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

Так что же представляет собой отчет об баге в процессе разработки программного обеспечения? Отчет об баге — это документ (в письменной форме или в формате видео), в котором точно указано, что пошло не так, как воспроизвести ошибку и каким было ожидаемое поведение системы. Цель отчета — предоставить разработчикам достаточный объем информации для того, чтобы они могли понять, приоритизировать и решить проблему, не тратя время на многочисленные уточнения.

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

Шаг 1. Определите, о каком баге вы хотите сообщить в отчете

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

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

Шаг 2. Начните запись экрана в Loom

Откройте Loom и выберите, что вы хотите записать: только экран или экран и видео с камеры. Для большинства багов достаточно только записи экрана. Вы можете включить камеру, если нужно что-то показать неспециалисту или сделать сообщение более неформальным.

Выберите конкретное окно или вкладку, где появляется баг. Запись нужной области экрана помогает следить за процессом, не отвлекаясь на другие открытые окна или постороннее содержимое.

Шаг 3. Воспроизведите и запишите действия, которые вызывают баг

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

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

Шаг 4. Четко обозначьте баг и опишите проблему

Когда на экране появится баг, сделайте паузу и укажите, в чем именно он заключается. Не думайте, что это очевидно. Точно опишите, где происходит сбой или что работает неправильно и как должно быть на самом деле.

Именно благодаря этому ваша запись станет действительно полезной для команд разработчиков. Четкое описание, сделанное в тот самый момент, когда возникает проблема, избавляет разработчиков от необходимости разбираться в непонятных временных метках или гадать, что имел в виду автор отчета.

Шаг 5. Во время записи укажите серьезность и возможные последствия проблемы

Продемонстрировав баг, кратко поясните, кого он затрагивает и как нарушает рабочий процесс или взаимодействие с пользователем. Баг, из-за которого пользователь не может завершить оформление и оплату заказа, будет намного серьезнее незначительной проблемы с отображением информации.

Укажите, как часто данный баг возникает, является ли он полным блокером и есть ли какие-либо известные обходные пути. Эта информация поможет определить приоритет для исправления ошибки.

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

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

Шаг 6. Просмотрите, сократите и отредактируйте отчет о баге с помощью Loom AI

Прежде чем отправить запись, еще раз просмотрите ее. Уточните все неясные моменты и уберите ненужные паузы или случайные заминки. Более короткое и информативное видео проще смотреть и использовать в качестве руководства к действию.

Loom AI упрощает эту задачу. Любой пользователь может создать качественную профессиональную запись, даже не имея опыта редактирования видео. Редактирование с помощью ИИ автоматически улучшает качество записи, что особенно полезно для участников команды, которые чувствуют себя некомфортно перед камерой, но все же должны четко излагать информацию.

Шаг 7. Поделитесь записью с командой, чтобы участники могли просмотреть ее в удобное время

Скопируйте ссылку на видео из Loom и отправьте ее команде по электронной почте, сообщением в Slack либо прямо в программу для отслеживания багов.

Если команда использует Jira, такую рассылку из Loom сделать еще проще. На вкладке Generate (Сгенерировать) есть кнопка Create in Jira (Создать в Jira), с помощью которой можно создать задачу прямо на доске Jira команды, не выходя из Loom. Видео, контекст и подробности, относящиеся к багу, будут отправлены прямо в систему, где выполняются задачи.

Там участники команды могут просматривать видео, оставлять комментарии и согласовывать дальнейшие действия с помощью асинхронных сообщений, не планируя для этого встреч. Асинхронное выполнение задач с помощью Loom предполагает, что участники распределенных команд могут просматривать, обсуждать и согласовывать задачи исходя из своего расписания. Это сокращает время обмена обратной связью и количество ненужных совещаний.

Что следует включать в отчет о баге?

Качественный видеоотчет о баге должен включать следующее:

• Четкие шаги для воспроизведения: опишите каждое действие, которое приводит к возникновению бага, чтобы разработчики могли легко его воспроизвести.
• Наглядную демонстрацию: покажите, что происходит на экране при возникновении бага, а не просто описывайте это словами.
• Ожидаемые и фактические результаты: четко опишите, что должно было произойти и что получилось в итоге. Такая формулировка позволяет сразу понять суть проблемы.
• Серьезность бага и его влияние на работу: объясните, на чью работу влияет баг и насколько он критичен, чтобы команда могла адекватно расставить приоритеты.
• Дополнительные характеристики: Loom автоматически собирает информацию о браузере и устройстве, но иногда полезно указать операционную систему, версию приложения или тип аккаунта.