Рекомендации по оформлению ошибок

Во время составления багрепорта для облегчения работы разработчиков обязательно включите в багрепорт следующие сведения:

1. Номер билда компонента/продукта. Например в ОС Microsoft Windows его можно узнать, посмотрев в Проводнике свойства файла, относящегося к компоненту, в котором обнаружена ошибка.
2. Конфигурацию компьютера.
3. Программное окружение (операционная система, а также список запущенных программ в момент возникновения ошибки).
4. Описание, достаточное для воспроизведения ошибки. Описывайте проблему настолько подробно, насколько это возможно. Представьте, что Вы сами будете разбираться с проблемой по своему описанию.
5. Файл конфигурации продукта/компонента.
6. Файлы отчётов (логи) компонента, в котором обнаружена ошибка.
7. Если возникла ошибка типа BSOD, необходимо заархивировать получившийся дамп памяти и выслать его на трекер технической поддержки (так как в нем нет ограничений на размер отправляемого файла), указав там, для какого бага отсылается дамп памяти, в багрепорте же нужно указать получившуюся ссылку на отправленный дамп. Также на саппортовский трекер следует отправлять все файлы, размер которых превышает 2Мб.
8. Если возникла ошибка "Программа выполнила некорректную операцию...", то необходимо к багрепорту приложить лог и дамп программы "Доктор Ватсон".
9. Если необходимо приложить к багрепорту снимок экрана (скриншот), то для этого желательно использовать форматы GIF и PNG, так как файлы, созданные в этих форматах, занимают меньший объём и не искажают изображение надписей на скриншотах, а значит, облегчают обработку багрепорта.
10. Не цитируйте файлы конфигурации и файлы отчётов целиком в поле основного описания ошибки, а прикрепляйте их в виде файлов. Частичное цитирование файлов отчётов и файлов для объяснения ошибки допускается.
11. Багтрекер разделён на публичную область, доступную всем пользователям, и закрытую (приватную), доступную сотрудникам ООО "Доктор Веб". Если Вы не можете прочитать некоторые сведения, которые даются в багрепортах сотрудниками компании (не отображаются некоторые сообщения, нет доступа к некоторым багрепортам, ссылки на которые даются), значит, эта информация находится в закрытом доступе.
12. Перед тем как оформлять очередной багрепорт, убедитесь, что найденная Вами ошибка не опубликована ранее в публичной области багтрекера. Закрытие Вашего багрепорта как дубликат багрепорта из закрытой области не означает, что Ваши усилия были напрасными, а наоборот, говорит о том, что Вы находитесь на правильном пути.

С уважением,
разработчики антивируса Dr.Web