Это совет‑шпаргалка: как улучшить сообщение о баге, чтобы помочь разработчикам быстрее и эффективнее среагировать и решить проблему.
Начнём с такого сообщения:
Втф, коллеги, я сейчас выставил новость про книгу и в той новости он мне у Жени очень некрасиво отрезал голову!
Последовательно улучшим его. Чем больше шагов получится выполнить, тем лучше.
1. Уберите шум. Почистите всё, что точно не относится к багу: эмоции, стоп‑слова, формализм:
Публикую новость и на фото у Жени обрезало голову.
2. Опишите ожидаемый и получаемый результат. Чётко сформулируйте суть проблемы и какое решение вы ждёте:
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
3. Уточните детали. Если баг повторяется в определённых условиях, браузере или устройстве.
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
На мобиле норм, не обрезается.
4. Добавьте ссылки. Дайте ссылку на место бага, на документацию и всё, что ускорит погружение разрабочика в контекст:
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
На мобиле норм, не обрезается.
Ссылка на новость: https://…
5. Добавьте контакты. Если есть люди, которые могут помочь расследовать или решить проблему.
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
На мобиле норм, не обрезается.
Ссылка на новость: https://…
Задачу по галерее делал Вова, но он сейчас в отпуске: @…
6. Уточните время появления. Только если уверены, что раньше в тех же условиях бага не было. Это поможет связать баг с релизами и быстрее найти причину.
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
На прошлой неделе в других новостях фото точно не обрезались.
На мобиле норм, не обрезается.
Ссылка на новость: https://…
Задачу по галерее делал Вова, но он сейчас в отпуске: @…
7. Укажите ответственных. Если пишете в общий чат, уточните, кто должен реагировать на сообщение:
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
На прошлой неделе в других новостях фото точно не обрезались.
На мобиле норм, не обрезается.
Ссылка на новость: https://…
Задачу по галерее делал Вова, но он сейчас в отпуске: @…
Игорь, сможешь поправить сегодня?
8. Добавьте скриншоты или видео. Помогите увидеть проблему, но не переусердствуйте.
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
На прошлой неделе в других новостях фото точно не обрезались.
На мобиле норм, не обрезается.
Ссылка на новость: https://…
Задачу по галерее делал Вова, но он сейчас в отпуске: @…
Игорь, сможешь поправить сегодня?
Не бойтесь писать очевидные вещи, они могут быть неочевидными для других. Конечно, в разумных пределах.
Вот, что у нас получилось:
Публикую новость, добавил фото в галерею, нужно чтобы на странице новости они были видны целиком, а сейчас голова актрисы обрезается.
На прошлой неделе в других новостях фото точно не обрезались.
На мобиле норм, не обрезается.
Ссылка на новость: https://…
Задачу по галерее делал Вова, но он сейчас в отпуске: @…
Игорь, сможешь поправить сегодня?
Сообщение постепенно стало гораздо лучше: понятна суть проблемы, примерная область поиска причины (релизы этой недели), есть ссылка для быстрого погружения, отладки и проверки исправлений.
Такое сообщение можно быстро обработать сразу или без изменений перенести в трекер задач на будущее. Уменьшается шанс, что баг проигнорируют или починят неправильно из‑за недостатка информации и нежелания разбираться.
А ещё его просто приятнее читать — видно, что автор уважает чужое время и хочет помочь решить проблему.
См. также:
P. P. S. Это был совет о веб‑разработке. Хотите знать всё о коде, тестах, фронтенд‑разработке, цеэсэсе, яваскрипте, рельсах и джейде? Присылайте вопросы.