Как правильно сообщать об ошибках, чтобы их быстро исправляли

Оглавление

Добрый день, уважаемые пользователи!

Если в процессе использования EOSmobile, вы столкнулись с ошибкой и хотите, чтобы мы как можно быстрее её исправили или предоставили разъяснения/рекомендации, пожалуйста, помните, что на выяснение деталей уйдет дополнительное время:

  • Если изложить суть ошибки непонятно или сумбурно
  • Если не предоставить описания компонентов или предоставить его не полностью

Как правильно сообщить об ошибке? #

Тема письма #

Любое обращение об ошибке на support@eos.ru начинается с темы.

Тема письма должна отвечать на два вопроса:

  • “Где?” — в каком месте интерфейса вы видите проблему?
  • “Что?” — что произошло?

Приведем примеры, когда заголовок отвечает на два вышеуказанных вопроса:

  • “EOSmobile 4.7.5 (iOS). Не уходит (завис) документ из папки “Неотправленные”.
  • “В разделе “Протоколирование” (СМР) появилась ошибка после обновления СМР”.
  • “В EOSmobile 4.7.4 (iOS) не выполняется подписании РКПД”.

Примеры неправильных заголовков:

  • “Ничего не работает” — Непонятно, что конкретно не работает и где.
  • “Кнопка заблокирована” — Непонятно, о какой кнопке идет речь и в каком приложении.
  • “Не работает синхронизация” — Непонятно, в чем это выражается и где.

Тело письма #

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

Что нужно указать в описании?

  • Контакты клиента:
    • Название организации;
    • Серийный номер программного продукта;
    • ФИО, должность, контакты лица, инициирующего заявку.
  • Окружение — приложение EOSmobile (iOS / Windows / Android) зависит от очень многих компонентов, поэтому нам важно понимать не только о каком приложении идет речь (версия приложения и на какой ОС), но также и его окружение (версия СЭД “ДЕЛО”, версия СМР, версия DMSIS из раздела “Программы и компоненты”). Если проблемы с электронной подписью, то сообщите версию «КАРМА» и КриптоПро CSP.
  • Шаги — Расписанные шаги помогают воспроизвести неполадку и навести разработчика на возможную причину ошибки. Например, когда вы по пунктам описываете, что делаете, и как это приводит к проблеме. Выполняя эти шаги, разработчик воспроизведёт ошибку под отладкой и сможет приступить к её исправлению.
  • Фактический результат — Напишите, что конкретно произошло.
  • Ожидаемый результат — Напишите, что должно происходить (изложите собственное мнение). Вместе с тем этот пункт позволяет лучше вас понять и использовать данную информацию для улучшения пользовательского опыта в будущих версиях.
  • Скриншот — В некоторых случаях заменяет тысячи слов, особенно если замечание касается интерфейса или дизайна.
  • Дополнительная информация — В зависимости от ошибки прикрепите такие файлы как:
    • выгрузку протокола с ошибками (СМР, раздел “Протоколирование”);
    • выгрузка документа, попавшего в “Стоп-лист” (СМР, раздел “Стоп-лист”);
    • выгрузка документа с которым связана ошибка (СМР, раздел “Выгрузка документов”);
    • файл с параметрами пользователя (СМР, “Экспорт настроек пользователя”);
    • логи EOSmobile (СМР, раздел “Прочие настройки” → “Директория хранения клиентских логов”);
    • выгрузка из EOSmobile (EOSmobile, “Настройки” → “Тех. поддержка” → кн. “Сообщить об ошибке”);
    • backup БД СМР (см. “Руководство администратора и технолога”).

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

EOSmobile (all)
Оцените документ

Работает на BetterDocs