Можно выделить несколько принципов написания хороших баг репортов:
- Тщательно объясните, как воспроизвести ошибку. Сообщите всю необходимую для этого информацию, а также свои размышления о возможных причинах возникновения ошибки.
- Описывайте всё максимально подробно. Особенно это относится к ожидаемому и фактическому результатам, а также шагам воспроизведения.
- Пишите отчёт понятно. Используйте общеупотребимую лексику, точные названия элементов ПС, аккуратно оформляйте написанное.
- Давайте ссылку на требование. Если это возможно, обязательно давайте ссылку на соответствующее требование, к нарушению которого приводит фактический результат выполнения ПО.
- Чётко указывайте окружение. Здесь имеется в виду ОС, браузер, настройки и т.п., под которым произошла ошибка.
- Помните, что в баг-репорте нет места эмоциям. Помните, что баг-репорт – это технический документ и мы пишем роботу .
- В одном отчёте описывайте ровно одну проблему. Если вы видите две ошибки – пишите два отчёта.
- Если вам хватает знаний, проведите начальный анализ возможных причин возникновения ошибки и опишите его результаты в разделе «Комментарии».
- Попытайтесь найти наиболее серьёзные последствия ошибки. Возможно, то, что казалось незначительны вначале, на самом деле может привести к очень серьёзным неприятностям.
- После написаний отчёта ещё раз внимательно его перечитайте. Убедитесь, что все необходимые поля заполнены, и всё написано верно.
- Помните, что вам же самим потом придётся верифицировать баг по своему же баг-репорту.
- Пишите отчёт об ошибке сразу же, как только вы обнаружили ошибку. Откладывание записи «на потом» приводит к тому, что вы или вообще забудете об этой ошибке, или забудете о каких-то важных деталях. Также несвоевременное написание отчёта об ошибке не позволяет проектной команде реагировать на её обнаружение в реальном времени.
Если существует какая-либо информация, которая может помочь быстро обнаружить и исправить ошибку, – сообщите эту информацию. Чего-то знаем – не боимся сообщить: экономим время програмистам (прибыль фирме увеличиваем), облегчаем жизнь, нарабатываете опыт и авторитет (в ответ – программисты еще какую хитрость, на будущее, подсказать могут).
