Шаблон баг репорта
Заполните поля и скопируйте готовый баг репорт в Markdown или обычным текстом. Всё работает в вашем браузере, к нам ничего не уходит.
Заполните шаблон
Одна строка, понятная с первого взгляда в списке: что сломалось и где.
Одно-два предложения контекста, чтобы было ясно, о чём речь.
По пунктам, от известного состояния, достаточно точно, чтобы другой человек попал на тот же экран.
Что продукт должен был сделать по макету или документации.
Что произошло вместо этого, описанное как симптом, а не как диагноз.
Браузер, операционная система, устройство, размер экрана и были ли вы в аккаунте.
Скриншот или короткое видео и строка о том, что на них видно.
Всё, что вывела консоль браузера, вставьте как есть. Оставьте пустым, если ничего не было.
Запросы, которые не прошли или ответили не тем, что ожидалось, из вкладки «Сеть».
Насколько это серьёзно, кого затрагивает и есть ли обходной путь.
Как часто это повторяется, с какого момента и что уже заведено рядом.
Отметьте, что вы сделали перед отправкой, чтобы читателю было ясно, что уже проверено.
Ваш баг репорт
Обе версии обновляются по мере ввода. Скопируйте ту, которую принимает ваш трекер.
# Баг-репорт
## Заголовок
[Чёткий заголовок - что сломалось и где]
## Описание
[Краткий обзор проблемы - 1-2 предложения]
## Шаги воспроизведения
1. [Первый шаг - от известного состояния]
2. [Второй шаг - точно опишите действия]
3. [Третий шаг - укажите использованные данные]
4. [Дополнительные шаги, если нужны]
5. [Последний шаг, который вызывает ошибку]
## Ожидаемое поведение
[Что должно происходить по замыслу или логике]
## Фактическое поведение
[Что происходит на самом деле - опишите симптомы]
## Окружение
- **Браузер:** [название и версия]
- **Операционная система:** [система и версия]
- **Устройство:** [компьютер или телефон, модель]
- **Разрешение экрана:** [если проблема в вёрстке]
- **Статус пользователя:** [в аккаунте или нет, роль]
## Визуальные материалы
[Приложите скриншоты или видео]
- Скриншот 1: [описание]
- Скриншот 2: [описание]
- Видео: [ссылка или вложение]
## Ошибки в консоли
```
[Вставьте ошибки из консоли браузера - F12 → Консоль]
```
## Проблемы с сетью
[Неудачные запросы к API из вкладки «Сеть» - F12 → Сеть]
## Влияние и серьёзность
- **Серьёзность:** [критично/высоко/средне/низко]
- **Кого затрагивает:** [всех / мобильных / определённую роль / и т. д.]
- **Влияние на бизнес:** [потеря выручки / нагрузка на поддержку / и т. д.]
- **Обходной путь:** [да/нет - если да, опишите]
## Дополнительный контекст
- **Частота:** [каждый раз / иногда / редко]
- **С какого момента:** [только что / после обновления / с [дата]]
- **Связанные задачи:** [ссылки на похожие баги]
- **Прочее:** [всё остальное, что может помочь]
## Чек-лист
- [ ] Проверил в чистом окружении (режим инкогнито)
- [ ] Указал шаги для воспроизведения
- [ ] Указал данные окружения
- [ ] Приложил скриншоты или видео
- [ ] Посмотрел ошибки в консоли
- [ ] Проверил, не сообщали ли об этом раньшеБАГ-РЕПОРТ
==========
ЗАГОЛОВОК
---------
[Чёткий заголовок - что сломалось и где]
ОПИСАНИЕ
--------
[Краткий обзор проблемы - 1-2 предложения]
ШАГИ ВОСПРОИЗВЕДЕНИЯ
--------------------
1. [Первый шаг - от известного состояния]
2. [Второй шаг - точно опишите действия]
3. [Третий шаг - укажите использованные данные]
4. [Дополнительные шаги, если нужны]
5. [Последний шаг, который вызывает ошибку]
ОЖИДАЕМОЕ ПОВЕДЕНИЕ
-------------------
[Что должно происходить по замыслу или логике]
ФАКТИЧЕСКОЕ ПОВЕДЕНИЕ
---------------------
[Что происходит на самом деле - опишите симптомы]
ОКРУЖЕНИЕ
---------
- **Браузер:** [название и версия]
- **Операционная система:** [система и версия]
- **Устройство:** [компьютер или телефон, модель]
- **Разрешение экрана:** [если проблема в вёрстке]
- **Статус пользователя:** [в аккаунте или нет, роль]
ВИЗУАЛЬНЫЕ МАТЕРИАЛЫ
--------------------
[Приложите скриншоты или видео]
- Скриншот 1: [описание]
- Скриншот 2: [описание]
- Видео: [ссылка или вложение]
ОШИБКИ В КОНСОЛИ
----------------
```
[Вставьте ошибки из консоли браузера - F12 → Консоль]
```
ПРОБЛЕМЫ С СЕТЬЮ
----------------
[Неудачные запросы к API из вкладки «Сеть» - F12 → Сеть]
ВЛИЯНИЕ И СЕРЬЁЗНОСТЬ
---------------------
- **Серьёзность:** [критично/высоко/средне/низко]
- **Кого затрагивает:** [всех / мобильных / определённую роль / и т. д.]
- **Влияние на бизнес:** [потеря выручки / нагрузка на поддержку / и т. д.]
- **Обходной путь:** [да/нет - если да, опишите]
ДОПОЛНИТЕЛЬНЫЙ КОНТЕКСТ
-----------------------
- **Частота:** [каждый раз / иногда / редко]
- **С какого момента:** [только что / после обновления / с [дата]]
- **Связанные задачи:** [ссылки на похожие баги]
- **Прочее:** [всё остальное, что может помочь]
ЧЕК-ЛИСТ
--------
- [ ] Проверил в чистом окружении (режим инкогнито)
- [ ] Указал шаги для воспроизведения
- [ ] Указал данные окружения
- [ ] Приложил скриншоты или видео
- [ ] Посмотрел ошибки в консоли
- [ ] Проверил, не сообщали ли об этом раньшеЭто работает в вашем браузере. Ничего из того, что вы вставляете или открываете, нам не отправляется.
Зачем нужно каждое поле
Шаблон баг репорта окупается тем, что снимает встречные вопросы. Заголовок и описание говорят разработчику, его ли это задача. Шаги, ожидаемое и фактическое поведение позволяют воспроизвести ошибку. Окружение, визуальные материалы и ошибки в консоли пропускают чаще всего, а именно они решают, починят ли ошибку сегодня или через неделю переписки.
Что делает баг репорт полезным
Пишите шаги от состояния, до которого читатель дойдёт сам, и указывайте введённые значения. Описывайте симптомы, а не причины: неверный диагноз уводит исправление не туда. Одна ошибка - один отчёт. И не выбрасывайте детали как очевидные: версия браузера, размер экрана и наличие входа в аккаунт чаще всего и объясняют, почему проблему больше никто не видит.
Расширение заполняет половину полей само
Session Replay собирает окружение, ошибки в консоли и визуальные материалы прямо со страницы, где случилась ошибка, так что три поля уже заполнены к моменту, когда вы открываете отчёт.