Как сообщить разработчикам об ошибке

Сообщаем разработчикам об ошибках

Примечание: ниже перевод статьи «Reporting bugs — a how-to guide», в которой приводится ряд нехитрых действий, которые могут помочь как пользователю, так и разработчику справиться с ошибками на сайте или в веб-приложении. В свете постоянного появления в Рунете проектов со статусом «бета», статья может быть особенно полезна.

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

«Оно просто не работает»

Когда вы обнаружили какую-либо проблему, крайне заманчиво тут же отправить email с минимальным описанием и предположить, что разработчик моментально его увидит и все поймет. Однако, потратив всего несколько минут на то, чтобы детально описать найденную проблему, вы можете предотвратить недопонимание со стороны разработчика и сэкономить его время, потому что ему не придется связываться с вами, чтобы узнать, что же на самом деле произошло и как это повторить, или же тратить свое время, чтобы пытаться ее воспроизвести самостоятельно.

Хороший отчет

Хороший отчет об ошибке должен сообщить разработчику три важные вещи:

• какое поведение ожидалось;
• что же на самом деле произошло;
• что вы при этом сделали или делали.

Какое поведение ожидалось

Существует два типа «ошибок»: в первом случае что-то ломается — и вы видите сообщение об ошибке, либо данные, которые вы загрузили, исчезли, либо вы отправили данные через форму, и данные не сохранились. Такие ошибки, в общем случае, довольно легко обнаруживаются, и о них просто сообщать: в этом случае разработчику достаточно знать, что же вы делали или вводили в это время, чтобы он смог воспроизвести эту ошибку, а затем исправить.

Второй тип ошибок заключается в том, что приложение действует не так, как вы ожидаете. Это может происходит в том случае, если разработчик неверно воплотил часть технического задания, но, может быть, приложение просто не может работать так, как вам хочется. В таком случае разработчик полагает, то оно работает так, как задумывалось, и оно действительно «работает», хотя, может быть, действительно неправильно. Если в своем сообщении об ошибке вы скажите, что эта возможность не работает, разработчик может потратить массу времени, пытаясь обнаружить какую-либо ошибку в этой части приложения, хотя ему всего лишь нужно понять, что оно не работает так, как вы ожидаете. Если в своем сообщении вы напишите о том, что ожидаете от приложения, то разработчику будет проще понять: «Хмм, ему хочется, чтобы происходило «А», но на самом деле происходит «Б» — и правильное решение будет принято значительно быстрее.

Что же на самом деле произошло

В действительно очень редко то, что происходит, можно назвать словом «ничего», хотя очень часто в сообщении об ошибке пишут именно «ничего не произошло». Если в реальности произошло «ничего» в терминах ожидаемого результата, значит, стоит это объяснить буквально в паре фраз. Например, если вы кликаете по кнопке «отправить» в форме, и она не отправляет данные формы и не переходит на следующую страницы, вы можете написать:

«Форма не отправляется — я остаюсь на той же странице, где был».

Но, возможно, в результате отправки формы появляется пустая страница:

«После отправки формы загружается пустая страница».

Если на экране появилось сообщение об ошибке, включите его в ваше сообщение. Просто скопируйте и вставьте его.

Если вы используете Internet Explorer, тогда ваш браузер может не показывать сообщения об ошибках, которые выдает сервер, а просто общую страницу с ошибкой. Убедитесь, что IE показывает именно то сообщение об ошибке, которое пришло от сервера. Для этого зайдите в Tools > Internet Options > Advanced, затем прокрутите вниз и выключите опцию Show friendly http error messages. Для пользователей IE 7 нужно зайти в Сервис > Свойства Обозревателя > Дополнительно и включить опцию Выводить подробные сообщения об ошибках http.

Что вы при этом делали

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

Последовательность действий

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

Любые введенные данные

Если проблема возникает после того, как вы вводите какие-либо данные в форму, включите эти данные в свое сообщение об ошибке. Если вы загружаете что-то на сервер, например, картинку, можно добавить и ее.

Иногда может оказаться полезным также скопировать и вставить URL из адресной строки браузера, чтобы разработчик точно знал, на какой странице вы в это время находились.

Браузер и операционная система

В случае веб-приложений проблемы могут возникать только в одном браузере. Обеспечьте (вашего) разработчика полной информацией о своей системе (включая номер версии), чтобы он смог воспроизвести окружение и протестировать его на возникновение проблемы.

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

• какое поведение ожидалось;
• что же на самом деле произошло; и
• что вы при этом сделали или делали.

Этого будет достаточно, чтобы выделить наиболее сложные проблемы из числа существующих. И если ошибку можно повторить, значит, она уже на полпути к устранению.

Спасибо всем, кто читал и читает мои переводы. Буду признателен за любые комментарии и дополнения. Удачи в устранении ошибок!

Web Optimizator: проверка скорости загрузки сайтов

Как сообщить о баге разработчикам: советы для эффективной обратной связи

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

Как найти баг

Перед тем, как сообщить о баге, его необходимо обнаружить. Некоторые баги могут быть очевидными, но некоторые могут проявляться только в определенных условиях, которые не сразу заметны. Если вы обнаружили баг, следует репродуцировать его, т.е. повторить действия, которые привели к возникновению ошибки.

Как сообщить о баге

1. Проверьте наличие подобных ошибок — перед тем, как сообщать о баге, убедитесь, что подобная ошибка еще не была обнаружена и зарегистрирована разработчиками. Если она уже была зарегистрирована, сообщайте о вашем случае в комментариях к уже существующей ошибке.
2. Подготовьте информацию — перед тем, как сообщить о баге, подготовьте информацию о том, как этот баг возникает. Опишите последовательность действий, которые приводят к ошибке, и ее проявление. Опишите, что именно происходит, какие сообщения об ошибке появляются, как приложение ведет себя в целом.
3. Выберите способ сообщения — разработчики часто предоставляют разные способы сообщения об ошибках. Можно оставить отзыв в специальном разделе на сайте продукта, написать в службу поддержки или на форуме. Но выбирая способ, учитывайте, что для разработчиков наиболее удобный способ это уведомление через багтрекинг-систему.
4. Приложите скриншоты — для более быстрого и точного выявления бага, приложите скриншоты, если они есть. Они помогут разработчикам лучше понять, как баг проявляется.

Как не следует сообщать о баге

1. Не оставляйте отзыв без подробного описания — важно описать последовательность действий, которая привела к ошибке, чтобы разработчики могли воспроизвести ее локально у себя на компьютере.
2. Не оставляйте негативных отзывов — если вы не только сообщаете о баге, но и выражаете свое недовольство, это может отвлекать внимание разработчиков от сути проблемы. Вместо этого объективно опишите проблему, используя конкретные факты и данные.
3. Не оставляйте сообщение без указания версии продукта — версия продукта может быть очень важной для быстрого решения проблемы. Укажите это в сообщении.

Вывод

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

Кто более или менее когда-либо сталкивался с проблемой на своем смартфоне, которая немного усложняет жизнь, и хотя в большинстве случаев они могут быть решены более или менее легко, в других случаях нет способа исправить это. Здесь есть возможность сообщать об ошибках в Android вступает в игру возможность, которая пытается помочь пользователю.

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

Разница между сообщением о проблемах и жалобой

Во многих случаях мы могли видеть, как пользователи оставляют свои проблемы на Twitter, официальные форумы или другие альтернативы, такие как Reddit, с намерением, чтобы кто-то им помог решить терминальную проблему . Это среднее значение является хорошим вариантом, поскольку нам требуется немного времени, чтобы записать, что с нами происходит, и, возможно, пользователь с тем же мобильным телефоном, что и мы, может помочь нам решить проблему, но, тем не менее, это будет неофициальная жалоба, которая в очень редких случаях дойдет ли он до ушей разработчиков мобильного бренда.

Однако, когда мы сообщаем об ошибке в Android, мы отправляем уведомление об инциденте на мобильном телефоне что у нас в руках, где мы будем демонстрировать, что происходит с устройством. Таким образом, наш отчет попадет в файл «официальных» жалоб, с которым команда рано или поздно приступит к работе.

В случае, если есть несколько пользователей с одной и той же проблемой, бренд сможет проверить ее актуальность и будет продвигать решение, чтобы количество жалоб не увеличивалось, а пользовательский опыт был желательным для всех. Скорость, с которой они будут действовать, будет зависеть от выполняемой ими работы и значимости ошибки.

Хотя было бы намного проще использовать одни и те же методы для сообщения о проблемах на всех телефонах Android, разнообразие уровней настройки означает, что у нас есть множество вариантов, которые мы должны учитывать при отправка проблемы на решение производителю . Это не поможет нам решить проблему на нашем смартфоне с помощью Google, поскольку она предназначена только для их смартфонов и не может контролировать, что бренды делают со своими адаптациями Android.

Действия, которые нужно выполнить в Google Pixel

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

Это откроет новую вкладку, где, используя нашу учетную запись Google, мы сможем разработать полную текст в нем мы описываем ошибку мобильного мы страдаем. Кроме того, у нас есть возможность добавить системный реестр это позволит разработчикам проверять состояние нашего устройства и, таким образом, упростить нам помощь. Этот отчет включает все: от версии Android до приложений, которые мы используем в настоящее время, или типа сети, к которой мы подключены.

Возможность сообщать об ошибках Xiaomi

В случае наличия смартфона с MIUI, нам придется прибегнуть к Xiaomiсобственное приложение под названием «Сервисы и комментарии», в котором мы можем создавать отчеты об ошибках Xiaomi, которые отправляются непосредственно бренду и через которые они могут работать над лучшим решением. Это самая продвинутая услуга, поскольку она дает нам возможность подробно объяснить с помощью различных вариантов, что с нами происходит.

Мы также можем объяснить проблему, добавить скриншоты и даже предложить предложения. Мы можем создать новый журнал ошибок после сбоя и внести свой вклад в нашу официальная жалоба на Xiaomi бесконечное количество вариантов, которые добавляют больше деталей к ошибке, чтобы они могли быстрее найти решение.

Сообщайте об ошибках на мобильных устройствах Samsung

В случае производителя Samsung, мы находим особую возможность сообщать об ошибках в членах Samsung. Мы можем использовать его на любом устройстве Samsung Galaxy, нам просто нужно получить доступ к приложению, которое входит в стандартную комплектацию устройства, и настроить его с помощью нашей учетной записи, чтобы получить доступ к возможности, которую мы вам покажем.

Чтобы начать процесс, нам нужно будет войти в раздел справки или коснуться плавающего пузыря, который дает нам возможность получить доступ к отчету об ошибке. После прикосновения к этому разделу будет сгенерирован полный список найденных ошибок, и мы сможем прокрутить до опишите возникшую проблему . Затем мы отмечаем поле «Отправить данные системного реестра» и приступаем к прикреплению снимков экрана, где мы можем показать проблему. Наконец отправляем и ждем ответа или решения в виде обновления.

Как это сделать на других телефонах Android

Многие производители, такие как OPPO or Huawei, не имеют собственной системы сообщения о сбоях но тем не менее извлекайте выгоду из отчета, который предлагает нам Google. В этом случае ошибка будет отправлена ​​непосредственно в компанию, и вам придется проделать несколько более длительный путь, поскольку затем она будет передана самому производителю, но все же использовать ее — отличная идея, поскольку она является наиболее полезной. расширенный вариант для этого. как мы собираемся научить вас дальше.

Создайте расширенный отчет об ошибке на Android

Самый полный вариант, который существует в Android, чтобы попытаться уведомлять производителей и сам Google о проблемах , это одна из возможностей для разработчиков, поэтому первое, что нам нужно сделать, чтобы ее использовать, — это войти в «Настройки»> «Информация» на телефоне и несколько раз нажать «Номер сборки», чтобы получить доступ к параметрам разработчика, находящимся в «Настройки»> «Система».

Затем пора искать «Отчет об ошибке», который мы можем сделать вручную или с помощью лупы поиска в настройках терминала. Как только мы его найдем, мы должны активировать его, и в зависимости от информации, которую вы нам предоставите, мы сможем использовать ее тем или иным образом. В стандартных телефонах Android мы должны нажать и удерживать кнопку питания, и она будет отображаться рядом с сетью параметров меню питания.

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

Приложения, которые не приносит мобил, проблема не производителя

Насколько мы пытаемся отправить проблему о приложении, которое мы загрузили с Гугл игры и уж тем более вне магазина решения проблемы мы не получим. Эти ошибки обычно связаны с приложением и его оптимизацией, поэтому нам нужно сделать следующее: направить нашу досаду на самого разработчика приложения .

Чтобы объяснить наши проблемы, мы заходим в Google Play, ищем нужное приложение и переходим к информации, чтобы попытаться найти способ связи. В большинстве случаев он недоступен, и поэтому нам придется использовать отзывы, чтобы оставить отзыв, в котором мы сообщаем о наших неудобствах. Чем больше информации мы добавим, тем легче будет устранить ошибку.

Как сообщать об ошибках

Автор: Магда Пьехота

Итак, ваша команда разработчиков создала это новое приложение для вашего клиента. Вы очень гордитесь этим и хотите показать это всему миру. Но прежде чем сообщить клиенту хорошие новости, вы должны протестировать приложение, чтобы найти ошибки, и ваша команда исправит их.

Найти ошибки относительно легко, вы просто используете приложение во всех возможных сценариях и проверяете, работает ли оно так, как должно работать. Что вас интересует, так это неправильное поведение приложения, сбои, сбои и так далее. Вещи, которые не были запланированы для приложения. И, конечно же, вы их найдете, но что дальше? Как показать их команде? Как сказать им, что и когда пошло не так?

Вы можете бежать к своим разработчикам каждый раз, когда находите ошибку, и показывать им, как вы с ней столкнулись. Иногда это даже работает. Но с командами разработчиков, разбросанными по всему миру, это может быть немного неудобно или даже невозможно. Вам нужен простой и подробный способ размещения описаний ошибок вместе с пошаговым руководством по их воссозданию.

В codequest мы используем шаблон для ввода отчетов об ошибках в наши пространства JIRA. Он очень точен, и если вы только будете его придерживаться, любой на самом деле сможет свободно сообщать об ошибках. Даже твой нетехнический клиент.

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

Итак, как мы сообщаем об ошибках? Вот небольшое пошаговое руководство:

Название ошибки

Дайте ему осмысленный, но короткий заголовок, например, «цвета круговой диаграммы отображаются неправильно».

Дата просмотра

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

Окружающая обстановка

В идеальной ситуации с обеспечением качества у вас будет три разных среды: разработка, подготовка и производство.

Каждый из них виден определенной группе людей в компании: —
— Разработка — это в основном то, чем занимаются разработчики компании. —
— Постановка предназначена как для разработчиков компании, так и для обзора клиентов.
— Производство предназначено для финального продукта, выпущенного для всего мира.

Чтобы помочь разработчику выявить ошибку, вам необходимо указать версию разработки среды, которую вы тестируете, и в которой заметили ошибку, а именно Development, Staging или Production.

Версии

Теперь укажите операционную систему и ее версию, в которой вы обнаружили ошибку, а также название программы и ее версию. Вы можете добавить названия и версии любого применимого программного обеспечения (например, веб-браузеров), установленного на вашем компьютере. Это важная часть информации, которая нужна вашим разработчикам для воссоздания ошибки в той же среде в их месте.

Описание ошибки

Далее следует краткое описание проблемы. Не забудьте оставить это чистое описание, здесь не используется повествование или разговорный язык.

приоритет

Когда описание готово, наступает время определить серьезность ошибки — действительно ли это что-то незначительное? Или, может быть, полная катастрофа, мешающая работе приложения? У вас есть пять уровней на выбор: Trivial, Minor, Major, Critical или Blocker. Используйте их, чтобы сигнализировать о важности проблемы вашей команде разработчиков.

Действия по воспроизведению

А теперь наступает сложная часть, момент, когда вы должны показать, насколько хорошо вы наблюдали за поведением приложения, пошаговое руководство, ведущее к воспроизведению внешнего вида ошибки в приложении. Дайте простые, но подробные инструкции о том, что делать. Ничего не предполагайте, а точнее предполагайте, что человек, который будет читать инструкцию, вообще не знаком с приложением. Чем подробнее будет ваш список инструкций, тем проще разработчику будет воссоздать и отследить проблему. Не паникуйте, действуйте методично, держите ноги на земле, а голову хладнокровной.

Фактическое поведение

В дополнение к чистому списку инструкций вам нужно добавить описание того, что происходит, когда вы следуете инструкциям. Не жалейте кровавых подробностей, чем больше, тем лучше. Ведь это и есть проявление описываемого вами бага!

Ожидаемое поведение

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

Предпринятые шаги по устранению неполадок/тестированию

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

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

Но если вы хотите стать хорошим тестировщиком приложений, это только начало пути…