1. Обращение должно быть понятным
Человек вне контекста прочитав его, должен быстро понять в чем проблема. Хороший баг-репорт или жалоба позволяют:
- Воспроизвести проблему (это не всегда возможно, но надо стремиться).
- Понять, в чем именно проблема (Тут не бывает много информации).
- Понять когда именно началась проблема.
- Понять какова ее важность (примерное количество пострадавших).
Если ты увидел баг и сразу, не теряя ни секунды, бежишь писать “ничего не работает!” Ты становишься такой же проблемой, как этот баг и это не комплимент. Когда программисты шутят про недалёких пользователей, это именно про тебя.
Идеальный алгоритм выглядит как-то так:
- Воспроизведи ошибку. Воспроизвелась? Отлично. Не воспроизвелась? Значит, что-то не учтено. Вспоминай. В большинстве случаев уже это помогает написать подробное описание.
- Если, это требуется, опиши проблему более подробно — уточни детали. Если понимаешь, в чем причина проблемы (используется устаревшая формула для расчетов, не учитывается какое-то значение и т.д.) — тоже пиши.
- Если проблема с визуальным отображением, то приложи скриншот или видео. Так можно будет понять ошибку и без воспроизведения шагов.
Что: неправильный расчет данных
Идеальный шаблон для 99% ситуаций
Где: на странице https://…. или на iphone 12
Когда: после ввода в поле Y отрицательного значения.
Запомни! Человек, который будет читать твое сообщение, загружен своей задачей и чем яснее объяснишь проблему, тем быстрее она будет решена.
2. Упрости себе жизнь
Если проблема с визуальным отображением, то скриншот обязателен, только так можно будет понять ошибку.
Сделать скриншот, очень просто:
- Windows или Linux:
Alt + Print Screen - Mac:
Command + Shift + 3 - Android:
Кнопка уменьшение громкости + Кнопка включения - iPhone:
Кнопка домой + Пробуждение
затем в окне любого мессенджера Ctrl + v
Для того чтобы пояснить проблему прямо на скриншоте, поставьте какую-либо программу:
- Snip & Sketch – только Windows 10
Windows key + Shift + S - ShareX – под все платформы
- Snipaste – только Windows 10
- Nimbus Capture – только Chrome
- Joxi – проект не развивается 🙁
- Yandex Disk – пакетом идёт Яндекс.Спам
Они сильно упростят вам всем вокруг вас жизнь.
Если это многошаговый баг, можно воспользоваться программой для записи видео:
- ShareX – под все платформы Free
- Nimbus Clarity – под все платформы ?
- Open Broadcaster Software – под все платформы
- TuneFab – под Win и Mac ?
- Loom – есть бесплатный тариф
- На компьютерах Mac есть востренная программа инструкция
- На компьютерах Windows есть Game DVR через Xbox app, если для вас это знакомые слова, попробуйте.
- Monosnap – только Mac
- getkap – только Mac
- recordMyDesktop – только Linux
- Movavi Screen Capture – платная
- Bandicam – платная
- Awesome Screenshot & Screen Recorder только Chrome
Запомни! Не присылайте ссылки, вместо скриншотов, если ты не пещерный человек.
3. Не упрекайте и не обвиняйте.
Прекрати повышать самооценку таким детским способом, даже если кажется, что проблема банальна и ты горишь от негодования. В работе нет места для негативных эмоций. Мы все работаем на результат, достичь его можно только слаженной работой. Цените (и возлюбите, если это возможно) своих коллег и они обязательно ответят вам взаимностью. Если проблема повторяется, можно и нужно менять процесс, продумать, как её избежать в следующий раз. Предложить решение, но ни в коем случае не скатываться в упрёки и, упаси тебя, никогда не переходите на личности.
Запомни! Если ты будешь хамить, тебе просто никто не захочет помогать.
4. Доведите дело до конца
Об ошибке мало заявить, надо ещё довести дело до конца. Убедитесь, что тебя услышали и кто-то проблемой занялся. Для этого лучше всего, в сообщении указать лицо, которое, по твоему мнению, ответственно за этот сектор работы или может найти того, кто всё починит.
Если сообщение не адресовано кому-то конкретно, то оно адресовано никому.