Как превратить заметки отладки в воспроизводимый баг-репорт
Хороший баг-репорт позволяет другому человеку понять проблему и попытаться воспроизвести её. Организация заметок помогает отделить доказательства от теорий, возникших при отладке.
Начните с подходящего материала.
- Что вы предоставляете
- предоставленные пользователем заметки о воспроизведении ошибки и наблюдения на текущей странице.
- Ожидаемый результат
- Сохраните структурированный отчёт о проблеме с фактическими подтверждениями и невыясненными условиями воспроизведения.
Как устроен рабочий процесс.
Запишите окружение, шаги воспроизведения, ожидаемое и фактическое поведение, а также предоставленные логи или ссылки. Помечайте неуверенные наблюдения и сохраняйте точный текст ошибки там, где он важен.
Что проверить в результате.
Проверьте, достаточно ли информации другому человеку для проверки сценария. Отсутствующие версии или шаги должны оставаться открытыми вопросами, а непроверенную гипотезу нельзя называть первопричиной.
Просмотрите Markdown, чтобы проверить заголовки, списки и ссылки, а также сам текст. Сохраняйте ссылки на источники вместе с документом, чтобы проверяющий мог проследить важные утверждения до предоставленных материалов.
Разберите готовый пример.
Скачиваемый пример Markdown показывает один вариант организации результата. Читайте его вместе с исходным примером и различайте зафиксированные факты, предложенные формулировки и вопросы без ответа.
Приведённый пример служит иллюстрацией. Это не запись запуска на ваших данных.
Скачать пример ↓Используйте со своими материалами.
- Откройте нужный источник и активируйте WebAct в этой вкладке.
- Скопируйте задание из верхнего блока, добавьте нужные поля или предпочтения и проверьте предложенные действия.
- Сравните первый результат с источником. При необходимости запросите конкретное исправление или уточнение.