Баг — это ошибка в работе программы, сайта, приложения. От того, как вы сообщите разработчикам о баге, напрямую зависит скорость и качество его исправления.
Сейчас расскажу, как написать разработчику о баге так, чтобы он всё понял. Тогда баг с меньшей вероятностью проигнорируют или исправят не так, как нужно.
Игорь Петров
руководитель разработки
Начнём с плохого примера
Ребята, у нас на странице рецепта фарша все списки опять поехали. Поправьте ASAP, выглядит ну супер-стрёмно.
Такое сообщение может сработать, если разработчики всю неделю работали с вами над страницей рецептов одного конкретного сайта и обладают всем нужным контекстом.
Но обычно у разработчиков много проектов и задач. Такое сообщение потребует времени и сил на вникание в контекст и вопросы.
- В лучшем случае оно рискует отправиться в долгий ящик «до выяснения обстоятельств»;
- В другом варианте вас завалят дополнительными вопросами — решение задачи затянется;
- В худшем случае — ребята додумают детали и «исправят» не то и не так, придётся переделывать.
Короче говоря, так нельзя.
Как улучшить сообщение о баге
Дайте больше контекста, помогите разработчикам быстрее понять проблему и ожидаемое решение. Уберите неоднозначность. Проследите, чтобы у задачи по исправлению появился конкретный ответственный.
1. Уберите эмоции и «воду».
Они не помогают понять задачу и могут кого-то задеть.
На странице рецепта фарша списки поехали.
2. Скажите как должно быть и как есть сейчас.
Не заставляйте разработчика гадать и делать исправления на свой вкус — рискуете зря потратить время и нервы.
На странице рецепта фарша списки поехали: по макету должны быть отступы между пунктами и красные маркеры, сейчас отступов нет и маркеры пропали.
3. Добавьте все нужные ссылки и инструкции.
Дайте ссылку на страницу с проблемой, объясните как её повторить. Это поможет разработчику не ошибиться с местом исправления, быстрее изолировать и отладить баг.
На странице рецепта фарша списки поехали: по макету должны быть отступы между пунктами и красные маркеры, сейчас отступов нет и маркеры пропали.
См. по ссылке список под заголовком «Если мясорубку заклинило»: https://…
4. Добавьте важный контекст.
Укажите устройство и браузер, где заметили баг. Если точно знаете, что бага в какой-то момент не было — сообщите, это ускорит поиск бага в системе контроля версий. Если кто-то недавно работал с проблемным участком — сообщите и дайте их контакты. Добавьте любую информацию, которая может быть важна разработчикам. Без фанатизма.
На странице рецепта фарша списки поехали: по макету должны быть отступы между пунктами и красные маркеры, сейчас отступов нет и маркеры пропали.
См. по ссылке список под заголовком «Если мясорубку заклинило»: https://…
Смотрю в Сафари на маке. На Винде вроде всё ок.
На прошлой неделе проблемы точно не было, в пятницу списки в админке менял контентщик Вася (@vasillo_foobarov), но он сейчас в отпуске.
5. Добавьте скриншоты и видео.
Лучше скриншотить экран целиком, включая адресную строку браузера или все панели приложения. Важные элементы можно особо отметить в графическом редакторе. Это поможет разработчикам быстрее понять проблему и часто даёт важную дополнительную информацию.
6. Укажите ответственных.
Если пишете в общий чат, уточните, кто именно должен реагировать на сообщение. Проконтролируйте, чтобы ответственный увидел задачу и подтвердил, что берёт её в работу.
Вот что у нас получилось в итоге:
На странице рецепта фарша списки поехали: по макету должны быть отступы между пунктами и красные маркеры, сейчас отступов нет и маркеры пропали.
См. по ссылке список под заголовком «Если мясорубку заклинило»: https://…
Смотрю в Сафари на маке. На Винде вроде всё ок.
На прошлой неделе проблемы точно не было, в пятницу списки в админке менял контентщик Вася (@vasillo_foobarov), но он сейчас в отпуске.
Игорь @petrowwww, посмотри, пожалуйста. Когда получится поправить?
Заключение
Да, пришлось потратить пару лишних минут, но сообщение стало гораздо эффективнее. Разработчикам железобетонно понятна проблема и ожидаемый от них результат, есть ссылки для быстрого погружения, отладки и проверки исправлений.
Шанс что такое сообщение проигнорируют, отложат в долгий ящик или поймут неправильно гораздо ниже, чем у исходного варианта.
Потраченные на такое сообщение минуты с лихвой окупаются, когда баг исправят через час, а не через неделю.
А ещё такое сообщение просто приятнее читать. Видно, что мы не просто пульнули абракадабру «на отвали», а позаботились о собеседнике, уважаем его время и хотим помочь решить проблему.
С чего начать изучение Axure RP
Как составить грамотное ТЗ для разработки
Путь сотрудника в IT-Agency от младшего до ведущего: как мы выращиваем кадры, которые ускоряют эволюцию бизнеса
Промпты: как собрать ключевые слова для продвижения приложения в App Store и Google Play
Как с помощью нейросетей экономить десятки тысяч рублей и рабочие дни команды: 3 кейса IT-Agency