Как записывать и отправлять журналы ошибок с помощью Loom
Сервис Loom позволяет записывать технические проблемы, дополняя визуальный контекст соответствующими журналами, панелями мониторинга и системными сообщениями. Вместо того чтобы полагаться исключительно на текстовые описания, специалисты могут увидеть, как возникла проблема, что отображалось на экране и какие действия привели к появлению ошибки.
Это помогает делать отчеты о багах, эскалацию обращений и разбор инцидентов более понятными, а реагирование на проблемы — более быстрым.
Шаг 1. Определите и воспроизведите проблему
Прежде чем записывать пошаговый разбор, точно определите, какую именно проблему вы хотите зафиксировать. Повторите последовательность действий, которая привела к возникновению проблемы, и обратите внимание на среду, действия пользователя и условия, при которых появилась проблема.
До начала записи важно убедиться, что проблему можно стабильно воспроизводить. Некоторые баги возникают только при определенных условиях, поэтому могут иметь значение такие детали, как браузер, устройство, роль пользователя, настройки учетной записи или время выполнения действий.
Шаг 2. Подготовьте соответствующие журналы и технический контекст
Затем откройте инструменты разработки, дашбоарды мониторинга или системные журналы, в которых зафиксирована ошибка. Найдите временную отметку, точно соответствующую моменту возникновения ошибки. Зафиксируйте все сообщения об ошибках и коды, которые могут содержать сведения об ошибке.
Также рекомендуется изучить события, происходившие непосредственно до и после возникновения ошибки, чтобы собрать дополнительный контекст.
Шаг 3. Запишите пошаговую демонстрацию проблемы с помощью Loom
После того как вы воспроизвели проблему и открыли соответствующие журналы, создайте наглядную демонстрацию в инструменте записи экрана от Loom.
Во время записи расскажите, какое поведение системы ожидалось, и четко покажите, где возникает проблема. Чем нагляднее описана проблема, тем проще ИТ-специалистам и разработчикам воспроизвести ее и установить причину возникновения. При необходимости вы также можете добавить голосовой комментарий после завершения записи проблемы с помощью Loom.
Шаг 4. Акцентируйте внимание на сообщениях об ошибках и реакции системы
Во время записи обратите внимание зрителей на конкретные сообщения, оповещения, неудачные запросы или другие проявления некорректной работы системы, которые могут помочь выяснить причину проблемы. Это позволит сопоставить происходящее на экране с техническими данными в журналах.
Недостаточно просто показать, что произошла ошибка. Объясните, как она влияет на пользовательский опыт, какой рабочий процесс нарушает и почему требует внимания. Такой дополнительный контекст поможет командам грамотно определить приоритетность и решить, что следует расследовать в первую очередь.
Шаг 5. Поделитесь записью Loom с заинтересованными сторонами
Когда вы заканчиваете записывать видео, оно автоматически добавляется в учетную запись Loom. Кроме того, в Loom создается ссылка, которой можно поделиться с заинтересованными сторонами.
Вы можете поделиться своей записью Loom с заинтересованными сторонами через приложения для совместной работы, которые вы уже используете, например Jira, Confluence или Slack. Отправьте запись инженерам, менеджерам по продукту или сотрудникам службы поддержки. Обмен записями Loom между командами разработчиков и специалистов поддержки упрощает взаимодействие между различными подразделениями.
Используйте настройки общего доступа Loom, чтобы нужные заинтересованные стороны могли просматривать запись и оставлять комментарии.
Шаг 6. Задокументируйте результаты и сохраните записи для дальнейшего использования
После устранения проблемы сохраните запись Loom вместе с остальной документацией по инциденту. Это позволит сформировать более полную картину произошедшего: как возникла проблема и какие действия помогли команде ее решить.
Такие записи также могут использоваться при разборе инцидентов, адаптации новых сотрудников и устранении аналогичных неполадок в будущем. Благодаря библиотеке видеороликов Loom команды могут упорядочивать записи по проектам, типам инцидентов, датам или системам, что облегчает их поиск в дальнейшем.