Шаблон отчета о проблеме (1035694)
Текст из файла
Отчет о проблеме
Технологические цепочки и роли участников проекта, использующих отчеты о проблемах. Связь отчетов о проблемах с другими типами проектной документации.
Каждое несоответствие с требованиями, найденное тестировщиком, должно быть задокументировано в виде отчета о проблеме. Вероятность обнаружения и исправления ошибки, вызвавшей это несоответствие, зависит от того, насколько качественно она задокументирована. Отчеты о проблемах могут поступать не только от тестировщиков, но и от специалистов технической поддержки или пользователей, однако их общая цель – указать на наличие проблемы в системе, которая должна быть устранена. Если отчет составлен некорректно, разработчик не сможет устранить проблему, поэтому можно считать этот отчет одним из самых важных документов в цепочке тестовой документации.
Главное, что должно быть включено в отчет об ошибке — это:
-
Способ воспроизведения проблемы. Для того, чтобы разработчик смог устранить проблему, он должен разобраться в ее причинах, самостоятельно воспроизведя ее (и, возможно, не один раз). Один из самых тяжелых случаев в процессе разработки возникает при невоспроизводимой проблеме, т.е. проблеме, у которой точно не известен способ ее вызывать. Нахождение такого способа – одна из самых нетривиальных задач в работе тестировщика.
-
Анализ проблемы с кратким ее описанием. Лучше всего приводить описание в тех же терминах, в которых составлены требования на часть системы, где обнаружена проблема. В этом случае минимизируется вероятность недопонимания сути проблемы.
Любой отчет о проблеме должен быть составлен немедленно после ее обнаружения. Если отчет будет составлен спустя значительное время, повышается вероятность того, что в него не попадет какая-либо важная информация, которая поможет устранить причину проблемы в кратчайшие сроки.
Структура отчетов о проблемах, их трассировка на программный код и документацию
Структура отчёта о проблеме в целом мало различается в различных проектах, изменения обычно касаются только порядка и имен следования полей. Некоторые поля могут отражать специфику данного конкретного проекта, однако обычно эти поля следующие:
-
Объект в котором найдена проблема. Здесь помещается максимально полная информация – для документации это название документа, раздел, автор, версия. Для исходных текстов это имя модуля, имя функции/метода или номера строк, версия.
-
Выпуск и версия системы. Определяет место, откуда был взят объект с обнаруженной проблемой. Обычно требуется отдельная идентификация версии системы (а не только версии исходных текстов), поскольку может возникнуть путаница с повторно выявленными проблемами. В этом случае, если проблема уже была когда-то выявлена разработчиком и потом вновь появилась из-за того, что в систему попала не самая последняя версия программного модуля, разработчик может решить, что ему пришел старый отчет и проблемы на самом деле не существует.
-
Тип отчёта:
-
Ошибка кодирования – код не соответствует требованиям.
-
Ошибка проектирования – тестировщик не согласен с проектной документацией.
-
Предложение – у тестировщика возникла идея, как можно усовершенствовать код.
-
Расхождение с документацией – поведение ПО не соответствует руководству пользователя или проектной документации либо вообще нигде не описано. При этом у тестировщика нет оснований объявлять, где именно находится ошибка.
-
Взаимодействие с аппаратурой – неверная диагностика плохого состояния устройства, ошибка в интерфейсе с устройством.
-
Вопрос – тестировщик не уверен, что это проблема, и ему требуется дополнительная информация.
-
Степень важности. Строгого критерия определения степени важности не существует, и обычно это поле кодируют от 1 (незначительно) до 10 (фатально). Однако способов обоснованной оценки нет – очень сложно определить, насколько фатальной может оказаться, например, опечатка в один символ в руководстве пользователя.
-
Суть проблемы. Краткое (не более 2 строчек) определение проблемы. Даже если две проблемы очень похожи, их описания должны различаться.
-
Можно ли воспроизвести проблемную ситуацию? Ответ = Да, Нет, Не всегда. Последнее – если проблема носит нерегулярный характер. Нужно описывать, когда она проявляется, а когда – нет (например, если не вовремя нажать не ту клавишу).
-
Подробное описание проблемы и способ её воспроизведения. При этом нужны подробности – и в описании условий воспроизведения, и в описании причины объявления получившейся реакции ошибкой.
Обычный вид отчета о проблеме, соответствующего данной структуре, следующий:
Отчёт о проблеме
Порядковый номер отчёта:
Автор отчёта: ___________________ Дата создания отчёта: __ __ __
Документы/разделы, связанные с проблемой:
……………………………………..
Идентификация объекта/процесса, где проявляется проблема:
………………………………………………………………………………………….
Определение проблемы:
………………………………………………………………………………………….
Автор решения: ___________________ Дата формирования решения __ __ __
Принятое решение: (возможно, ссылки на изменяемые компоненты/запросы на изменения)
………………………………………………………………………………………….
Результаты анализа, определяющие, на содержание каких компонент влияет решение:
………………………………………………………………………………………….
План проверок, восстанавливающих текущее состояние документов разработки
………………………………………………………………………………………….
Оценка принятого решения автором отчёта о проблеме: _
………………………………………………………………………………………….
( 0 = полностью согласен
1 = не все аспекты проблемы учтены/разрешены
2 = основная часть проблемы осталась неразрешённой
3 = решение не адекватно проблеме – не устраняет её)
Характеристики
Тип файла документ
Документы такого типа открываются такими программами, как Microsoft Office Word на компьютерах Windows, Apple Pages на компьютерах Mac, Open Office - бесплатная альтернатива на различных платформах, в том числе Linux. Наиболее простым и современным решением будут Google документы, так как открываются онлайн без скачивания прямо в браузере на любой платформе. Существуют российские качественные аналоги, например от Яндекса.
Будьте внимательны на мобильных устройствах, так как там используются упрощённый функционал даже в официальном приложении от Microsoft, поэтому для просмотра скачивайте PDF-версию. А если нужно редактировать файл, то используйте оригинальный файл.
Файлы такого типа обычно разбиты на страницы, а текст может быть форматированным (жирный, курсив, выбор шрифта, таблицы и т.п.), а также в него можно добавлять изображения. Формат идеально подходит для рефератов, докладов и РПЗ курсовых проектов, которые необходимо распечатать. Кстати перед печатью также сохраняйте файл в PDF, так как принтер может начудить со шрифтами.















