Как правильно прикреплять ссылки/артефакты к багу

1️⃣ Как кратко ответить

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

2️⃣ Подробное объяснение темы

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

Зачем это нужно

1. Ускорение воспроизведения бага: Артефакты, такие как скриншоты и видео, помогают разработчикам быстро понять, как воспроизвести баг.
2. Улучшение коммуникации: Четкие и полные артефакты уменьшают количество вопросов и недопонимания между тестировщиками и разработчиками.
3. Документация: Артефакты служат доказательством существования бага и могут быть использованы для анализа в будущем.

Что прикреплять

• Скриншоты: Показывают точный момент, когда произошла ошибка. Используйте инструменты для выделения важных деталей на изображении.
• Видео: Демонстрируют последовательность действий, ведущих к багу. Это особенно полезно для сложных сценариев.
• Логи: Содержат технические детали, которые могут указать на причину проблемы. Включайте логи сервера, клиента или системы.
• URL-адреса: Указывают на конкретные страницы или ресурсы, где возникает баг.
• Конфигурационные файлы: Могут быть полезны, если баг связан с определенными настройками системы.

Как прикреплять

1. Используйте понятные имена файлов: Названия должны отражать содержание файла, например, login_error_screenshot.png.
2. Обеспечьте доступность: Убедитесь, что все ссылки и файлы доступны для всех членов команды, кто может работать над багом.
3. Организуйте артефакты: Если баг сложный и требует множества артефактов, организуйте их в логической последовательности.
4. Объясните содержание: В описании бага укажите, что именно показывают прикрепленные артефакты и как они связаны с проблемой.

Пример

Предположим, вы нашли баг в процессе авторизации пользователя. Вы можете прикрепить следующие артефакты:

• Скриншот: login_error_screenshot.png — показывает сообщение об ошибке на экране.
• Видео: login_process.mp4 — демонстрирует шаги, которые вы предприняли для воспроизведения бага.
• Логи: server_log.txt — содержит записи, которые могут указать на причину ошибки.
• URL: https://example.com/login — страница, на которой возникает баг.

В описании бага укажите: "При попытке входа в систему на странице https://example.com/login возникает ошибка. См. скриншот login_error_screenshot.png и видео login_process.mp4 для воспроизведения. Логи сервера server_log.txt содержат дополнительную информацию о возможной причине ошибки."