Шаблон баг-репорта
Нейросеть составит баг-репорт из ваших заметок об ошибке в программе или на сайте. Вы получите описание проблемы, шаги воспроизведения, ожидаемый и фактический результаты, а также список недостающих сведений.
Что указать в промпте
- Какая ошибка возникла
Расскажите, что вы делали и какая проблема возникла. Опишите только то, что действительно увидели, без догадок о причине ошибки.
Пример: «После нажатия кнопки сохранения название задачи не меняется»
- Как воспроизвести ошибку
Перечислите действия от открытия нужной страницы до появления ошибки. Укажите названия кнопок и другие детали, которые помогут повторить ваши действия.
Пример: «Открыть задачу, изменить название и нажать «Сохранить»»
- Что ожидалось и что произошло
Напишите, какой результат вы ожидали получить и что произошло на самом деле. Если правильное поведение пока неизвестно, это можно отдельно уточнить.
Пример: «Ожидалось новое название, после сохранения осталось прежнее»
Что вы получите
- Готовый баг-репорт с описанием ошибки и шагами воспроизведения
- Список недостающих сведений для уточнения ошибки
Не придется вручную собирать отчет из разрозненных заметок. Разработчик увидит, какие действия привели к ошибке, что должно было произойти и что случилось на самом деле. А список вопросов поможет дополнить описание, если важных деталей не хватает.
Как проверить баг-репорт перед отправкой разработчику
Прочитайте готовый баг-репорт и попробуйте повторить ошибку по записанным шагам. Проверьте, что действия идут в правильном порядке, названия кнопок совпадают с интерфейсом, а ожидаемый результат не перепутан с фактическим. Если известно, в какой версии приложения и браузере возникла проблема, добавьте эти сведения. Снимок экрана тоже пригодится, если на нем видна ошибка. Перед отправкой уберите из вложений пароли, токены и личные данные.
После проверки передайте баг-репорт разработчику через систему задач, которую использует ваша команда. Приложите снимки экрана или журналы ошибок, если они помогают понять проблему, и ответьте на вопросы из отчета. ИИ уже стал привычным инструментом в разработке — 85% разработчиков регулярно используют ИИ-инструменты. Если вы подготовили описание с нейросетью, особенно внимательно сверьте его с собственными наблюдениями, чтобы в задачу не попали выдуманные детали.
Как составить баг-репорт с помощью ИИ
Допустим, вы меняете название задачи в приложении, нажимаете «Сохранить», а на экране остается старое название. Нужно сообщить разработчику об ошибке, но как правильно ее описать? Промпт для шаблона баг-репорта поможет превратить ваши заметки в понятный отчет. Нейросеть оформит последовательность действий, ожидаемый и фактический результаты и покажет, что еще нужно уточнить.
Начните с заголовка, по которому сразу понятно, что сломалось. Например, «Название задачи не сохраняется после редактирования» гораздо полезнее, чем «Не работает кнопка». В первом случае разработчик понимает, какую функцию нужно проверить и при каком действии возникает проблема. Не стоит добавлять в заголовок предполагаемую причину вроде «Ошибка базы данных», если вы не знаете, почему сохранение не сработало.
Затем запишите действия, которые привели к ошибке. Допустим, вы открыли существующую задачу, изменили ее название и нажали «Сохранить». Эти три шага важнее длинного рассказа о том, что вы делали до этого. Если проблема появляется только в определенной ситуации, например при редактировании уже созданной задачи, обязательно укажите такое условие. Разработчик должен понимать, с чего начать и какие действия повторить.
Остается разделить ожидаемый и фактический результаты. В нашем примере ожидалось, что после сохранения появится новое название задачи, а фактически осталось прежнее. Если правильное поведение не описано в требованиях, его лучше уточнить у владельца продукта. Для подготовки таких технических описаний используют и нейросети. О масштабах распространения одного из подобных инструментов рассказывает статистика аудитории ChatGPT.
Пример заполнения баг-репорта об ошибке сохранения задачи
| Раздел баг-репорта | Пример |
|---|---|
| Условия воспроизведения | В приложении открыта существующая задача |
| Шаги воспроизведения | Изменить название задачи и нажать кнопку «Сохранить» |
| Ожидаемый результат | После сохранения на экране отображается новое название задачи |
| Фактический результат | После нажатия «Сохранить» на экране остается прежнее название |
Когда разработчик исправит ошибку, нужно будет проверить, что проблема больше не возникает. Для подготовки сценариев тестирования и других задач по работе с кодом пригодится библиотека промптов для программирования. Раздел постепенно наполняется новыми инструкциями. Сохраните исходный баг-репорт и подтвержденные шаги воспроизведения, чтобы сравнить поведение приложения до и после исправления.
Вопросы о подготовке баг-репорта
Как составить шаблон баг-репорта с помощью ИИ?
Чтобы заполнить шаблон баг-репорта, передайте нейросети описание ошибки, действия перед ее появлением и то, что вы увидели на экране. ИИ оформит заголовок, шаги воспроизведения, ожидаемый и фактический результаты. Если вы не указали браузер, версию приложения или другие важные условия, нейросеть добавит их в список вопросов, а не станет придумывать ответы.
Определит ли ИИ причину ошибки по описанию проблемы?
Для баг-репорта важнее точно записать наблюдаемое поведение, чем угадать причину. Например, если после сохранения осталось прежнее название задачи, это еще не означает, что сломалась база данных. Нейросеть оформит известные факты и выделит недостающие сведения. Поиск технической причины потребует отдельного разбора кода, запросов или журналов приложения.
Что указать в промпте, если ошибка возникает не каждый раз?
Опишите попытки, при которых ошибка появилась, и те, когда все работало нормально. Например, название задачи не сохранилось после одного из нескольких изменений. Если заметили связь с определенным браузером, страницей или действием, укажите ее. Не пишите, что ошибка возникает в половине случаев, если вы не считали попытки. Неизвестную частоту лучше оставить для уточнения.
Как описать ожидаемый результат, если неизвестно правильное поведение программы?
Запишите фактический результат, а ожидаемый отметьте как требующий уточнения. Допустим, после нажатия кнопки «Удалить» запись осталась на экране. Возможно, приложение должно убирать ее сразу или только после подтверждения сервера. Это зависит от правил продукта. Уточните их у владельца задачи и дополните баг-репорт подтвержденным ожиданием.
Какие снимки экрана и другие вложения добавить к баг-репорту?
Приложите снимок экрана, на котором видна проблема, или короткую запись действий, если ошибка проявляется в последовательности шагов. При наличии подходящих журналов приложения добавьте сообщения об ошибках. Например, снимок формы с прежним названием задачи поможет показать фактический результат. Перед отправкой скройте пароли, токены, личные сведения пользователей и другие данные, которые нельзя передавать разработчику.
