2021-11-06 11:50:00
Как зарепортить баг, чтобы на него обратили внимание?
Даже в мире сообщений об ошибках вам нужно произвести хорошее первое впечатление. Так как же сделать так, чтобы отчет об ошибке сразу призывал к действию? Все просто.
Расскажите об ошибке с точки зрения пользователя!
Когда вы сталкиваетесь с проблемой и хотите сообщить о ней, опишите трудности, с которыми вы столкнулись, или невозможность выполнить задачу.
Почему? Описывая взаимодействие со стороны пользователя, команда разработчиков, оценивающая ошибку, о которой вы сообщили, может лучше понять, в чем проблема пользователя, на что она влияет, и даже посочувствовать ему.
Само собой разумеется, что вы должны избегать очень загадочного описания ошибки. Конечно, технические детали важны, но не стоит начинать описание ошибки с технической тарабарщины. Короче говоря, не усложняйте команде разработчиков задачу определения проблемы пользователя.
Вот пример. Какое из двух описаний ошибок ниже легче понять?
1.
«Исключение произошло, когда я ввел « My files.docx »и нажал ОТКРЫТЬ»
2.
«Я не могу читать / писать / открывать файл, если в его имени есть пробелы».
Надеюсь, вы выбрали второе. Во втором четко указано, с какой проблемой сталкивается пользователь. Это облегчает разработчикам понимание проблемы в их ПО и ее влияние на то, что пытается выполнить пользователь. Это понимание, вероятно, приведет к более быстрым действиям и точному определению приоритетов ошибки.
Вот еще один пример:
«Не работает в любом браузере Chrome. Приложение не позволяет мне войти в систему с помощью этого браузера ».
Расскажите о проблеме и о том, что пользователь не может сделать. Мало того, что пользователь не может войти в систему, он вообще не может выполнять какую-либо работу!
Если вы аккуратно относитесь к словам, все вышесказанное можно выразить проще:
«Невозможно войти в приложение из любого браузера Chrome»
Приведенные выше сообщения намного лучше, чем, к примеру:
«Появляется Exception при вызове loginBrowser ()»
Этот пример скорее заставит разработчика проскроллить ваше сообщение.
И есть приятный побочный эффект
Сообщая об ошибках с точки зрения пользователя, вы косвенно обучаете разработчиков тому, как люди используют их ПО. Команда разработчиков, возможно, никогда не рассматривала описанный вариант использования, и вы открыли им глаза.
Но не стоит драматизировать
Всегда сообщайте о проблеме, с которой вы столкнулись, только на основании фактов и своих наблюдений. Избегайте использования слов, которые могут искусственно преувеличивать важность или срочность проблемы. Короче говоря, не добавляйте ненужные слова или описания ради привлечения внимания.
Суть в том, что вы должны сообщать о проблеме, чтобы она получила внимания столько, сколько она заслуживает.
2.7K views08:50
У
