Как правильно оформить баг репорт, что бы он был полезен.

v_SaHaLiNN_v · 23 января

Введение

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

Баг увидеть очень просто, а вот правильно зафиксировать его - это целое искусство. Давайте с вами научимся это делать.
Начнем с ошибок. Какие ошибки делают все из вас?

Основные ошибки.

Игнорирование ошибки. Ну крашнулась игра, ну открылось окошко со второго раза - какое мне дело? На самом деле это одна из основных ошибок. Любую ошибку надо фиксировать и документировать. Может быть такое, что вы единственный, у кого всплыла эта ошибка. Также не стоит надеяться на других, иначе может быть такое, что все будут надеяться друг на друга и никто ошибку так и не запостит.
Повторяющиеся баг репорты. Нашли ошибку? Похвально, но перед тем как бежать на форум и ПОСТИТЬ ВОТ ТАКИМ ВОТ ШРИФТОМ ОШИБКУ, нужно хотя бы воспользоваться поиском. Вдруг эту ошибку уже нашли?
Поищите вот здесь: https://community.gaijin.net/issues
Если ошибка не найдена, с чистой совестью открывайте новую тему. Но если такая ошибка есть, писать про нее во второй, третий или 10й раз не нужно.
Неправильно оформленный багрепорт. Много ли вы поймете из такого описания: "Невозможно играть, всюду серый цвет!!!" ? Разработчики тоже ничего не поймут, поэтому правильное описание ошибки - залог успешного устранения этого бага.

Как правильно оформить баг репорт.

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

Состав репорта.

Заголовок.
Пожалуй это одна из самых важных частей вашего багрепорта. Заголовок должен быть кратким и лаконичным. После его прочтения уже все должны понимать, в чем собственно заключается ошибка.
Пример хорошего заголовка: "Самолет Mustang P51D. Пропадают текстуры после попадания по самолету".
Пример плохого заголовка: "Ошибка! Что-то странное у Мустанга".
Краткое описание ошибки.
Итак, вы придумали заголовок, теперь надо в общих чертах описать, что собственно не так, чтобы по этому описанию уже было понятно, что эта за ошибка, почему она происходит и как примерно ее искать. Описание должно быть не очень длинным, но понятным.
Пример хорошего краткого описания: "После того, как по моему самолету Mustang P51D повредили крыло, на нем пропали текстуры летнего камуфляжа".
Пример плохого описания: "Господа разработчики, сколько можно это терпеть! Что творится с самолетом P51D? Когда это прекратится??? У меня все исчезает!!!"
Также дополнительно можно приложить видео. Но не без письменного описания проблемы.
Алгоритм воспроизведения (ВТР).
ВТР - англ. Ways To Reproduce, по-русски - Шаги По Воспроизведению.
Это самая важная часть вашего баг репорта, без которой он немыслим. Это пошаговая инструкция для воспроизведения бага. Да, прямо по пунктам 1, 2, 3 и т.д. Каждый пункт должен содержать в себе одно действие - предельно понятное и простое. Бывает такое, что пошаговую инструкцию не составить (баг рандомный), тогда подробно опишите события в игре до того как баг произошел, которые предположительно могли вызвать проблему: что делали, на каком самолете летали, в каком режиме боя, на какой карте и т.д.
Пример правильно оформленного алгоритма воспроизведения (ВТР): Репорт
Повторы боя.
При описании некоторых багов требуется приложить повтор боя. Это может помочь программистам найти искомый баг. Желательно приложить повтор клиентский (из вашей папки игры Replays) и ссылку на серверный реплей - с сайта.

Клиентский повтор по умолчанию сохраняется автоматически в директории с игрой в папке replays (если вы не отключили это в настройках игры).
Серверный повтор можно найти с помощью сообщений игры внизу справа. (откроется сайт с повтором)

Время воспроизведения на повторе. Будет очень здорово указать, на какой минуте боя (примерно) произошел баг, а также указать примерное Московское время, когда случился баг - это сильно поможет программистам.
Описание правильной работы.
Опциональный пункт. Иногда имеет смысл описать корректное поведение игры.. Если у вас есть информация о том, как все должно работать на самом деле - не стесняйтесь ею поделиться.
Воспроизводимость
Повторяемость появления этого бага. Градируется от "не повторялся" до "повторяется всегда". Повторяемость:
- Всегда
- Рандомно
- Иногда
- Один раз
- Не повторял баг
Логи. Самый обязательный пункт.
Игра подобно черному ящику в самолете записывает все ваши действия в игре. а также массу игровых параметров в специальные текстовые файлы. Логи находятся в директории установки игры “\Папка с игрой\.game_logs\”. Сохраняются после закрытия игры.
Скриншот(ы). Без скриншотов логи бесполезны.
Скриншот создает в логах пометку, с помощью которой можно найти нужное место, среди огромного количества текста. Скриншоты снимаются в папку игры по нажатию на Print Screen.
Если ошибка не связана с графикой, то не обязательно чтобы ошибка была видна на скриншоте, главное сделать его в момент воспроизведения ошибки
Скриншоты из повтора бесполезны! Когда вы смотрите повтор - вы не совершаете никаких действий, а просто смотрите “кино”. Во время повтора логи не пишутся кроме действий с самим видео.
В случае проблем с производительностью игры (игра тормозит/упал FPS/ фризы), Дополнительно к предыдущим пунктам понадобится лог производительности.
Для создания такого лога нужно запустить игру, войти в бой и нажать левый Alt + F11 (если у вас включен оверлей NVidia - отключите его), чтобы включить или выключить запись.В момент падения производительности однократно нажать F11.
После этого в папке с логами “\Папка с игрой\.game_logs\” появится файл с расширением .dap, который нужно приложить в репорт.
Если профайлер запущен (ALT+F11), спайки (кратковременные зависания) создаются в spikes-date_time.dap, а по F11 - ring-datetime.dap

При включении записи профайлера сверху должна появиться белая надпись.
Profiler enabled. Press Left_Alt + F11 to disable and F11 to dump performance to log.

При сохранении информации профайлера в лог появится надпись
Performance profiler info saved near logfile.

После завершения записи вы можете отключить профайлер нажав снова Alt + F11 и тогда появится запись об его отключении.
Profiler disabled. Press Left_Alt + F11 to enable it again.
Если проблема произошла с лончером игры - приложите его логи.
Логи лончера расположены в директории …/War Thunder/.launcher_log.
Если проблема связана с управлением, то дополнительно приложите файл со своими настройками управления. Чтобы сохранить управление, нужно экспортировать его в текстовый документ. Кнопка для экспорта в файл находится в настройках управления внизу.
DxDiag.
Или иными словами конфигурация вашего компьютера. Наша игра мультиплатформенная: и вполне возможна такая ситуация, что на вашем компьютере баг воспроизводится, а на компьютере программистов - нет. Благодаря этому файлику, программисты смогут найти компьютер похожий на ваш, и таки воспроизвести ошибку.

Как снять DxDiag.

На своём компьютере:

Нажмите сочетание клавиш Win + R
В поле внизу пишем: DxDiag и жмем Enter
Дождитесь окончания обработки
Нажмите на кнопку "Сохранить все сведения"
DxDiag будет сохранен как txt файл, после этого его можно прикладывать к вашим ошибкам.

Советы.

Помните, что без алгоритма воспроизведения или хотя бы краткого описания ваш багрепорт малоинформативен. Поэтому просто логи или просто скриншоты без описания причины появления ошибки ничего не скажут программистам и могут быть закрыты. В логе содержатся десятки тысяч строчек и фраза о том, что вот в этом логе где-то там ошибка звучит для программистов как издевательство. (Совет от kylewarm - Шерстистая львиность)
Аналогична и обратная ситуация. Даже самое прекрасное описание ошибки будет бесполезно, если вы забыли приложить лог и скриншот.
Если ошибка похожа на другую вашу ошибку - дайте ссылку на нее.
Не бойтесь экспериментировать. Проверьте все типы управления, проверьте все ваши джойстики. Не стесняйтесь залезать во все менюшки в игре.
Если что-то непонятно, пишите в этой теме или же можно написать в личные сообщения альфа тестеру / КБР или помощникам. Вам с радостью помогут.
На сайте для репортов вы можете увидеть различные подсказки при оформлении репорта. Выбрав нужную категорию.