Тестовая документация при тестировании программного обеспечения (пример)

Что такое тестовая документация?

Тестовая документация — это документация артефактов, созданных до или во время тестирования программного обеспечения. Она помогает команде тестировщиков оценивать необходимые трудозатраты, отслеживать ресурсы и прогресс, а также обеспечивать достаточное покрытие тестами. Записи и отчёты о тестировании представляют собой полный набор документов, позволяющих описывать и документировать планирование тестирования, разработку теста, его выполнение и результаты, полученные в ходе тестирования.

👉 Зарегистрируйтесь на бесплатный проект по живому тестированию программного обеспечения

Зачем нужна формальность в тестировании?

Новичку легко предположить, что тестирование — это выполнение различных фрагментов кода по мере необходимости и проверка результатов. Но в реальном мире тестирование — это очень формализованная деятельность, которая подробно документируется. Тестовая документация упрощает планирование, проверку и выполнение тестирования, а также делает их более проверяемыми.

Степень формальности теста зависит от:

• Тип тестируемого приложения (AUT).
• Стандарты, которым следует ваша организация.
• Зрелость процесса разработки.

Тестирование обычно занимает от 30% и 50% от общего объема работ по разработке программного обеспечения. Документация помогает выявить пути улучшения процесса тестирования, которые можно применить в будущих проектах.

Какие существуют типы тестовой документации?

Вот важные типы тестовой документации:

«На практике эти документы создаются на разных этапах — от раннего планирования (политика тестирования, стратегия) до исполнения и закрытия (отчеты о дефектах и ​​сводные отчеты)».

Типы документов тестирования	Описание
Политика тестирования	Это документ высокого уровня, описывающий принципы, методы и все важные цели тестирования организации.
Стратегия тестирования	Документ высокого уровня, определяющий уровни (типы) тестирования, которые необходимо выполнить для проекта.
План тестирования	План тестирования — это полный документ планирования, содержащий объем, подход, ресурсы, график и т. д. мероприятий по тестированию.
Матрица отслеживания требований	Это документ, который связывает требования с тестовыми примерами.
Сценарий тестирования	Сценарий тестирования элемент или событие программной системы, которое может быть проверено одним или несколькими тестовыми случаями.
Тестовый кейс	Это группа входных значений, предварительных условий выполнения, ожидаемых постусловий выполнения и результатов. Она разработана для тестового сценария.
Тестовые данные	Тестовые данные — это данные, существующие до выполнения теста. Они используются для выполнения тестового случая.
Отчет о дефектах	Отчет о дефекте — это документированный отчет о любом недостатке в программной системе, который не позволяет ей выполнять ожидаемую функцию.
Сводный отчет о тестировании	Сводный отчет об испытаниях представляет собой документ высокого уровня, в котором обобщаются проведенные мероприятия по испытаниям, а также их результаты.

Каковы наилучшие методы создания тестовой документации?

В этом разделе мы изучим лучшие практики, которые помогут вам создать тестовую документацию, с примерами, которые помогут вам лучше ее понять:

• Привлекайте отдел контроля качества на ранних этапах проекта: Подключите команду QA с самого начала проекта, чтобы тестовая документация разрабатывалась параллельно с дизайном продукта и требованиями.
  Пример: QA сотрудничает в ходе планирования спринта для составления первоначальных тестовых случаев на основе пользовательских историй.
• Поддерживайте актуальность документов: Не создавайте тестовые документы и не забывайте о них — обновляйте их всякий раз, когда изменяются требования или функции.
  Пример: При изменении API входа немедленно обновляйте соответствующие тестовые случаи и результаты.
• Используйте контроль версий: Управляйте и отслеживайте все изменения в тестовых документах с помощью систем контроля версий, чтобы избежать путаницы и потери данных.
  Пример: Сохраняйте планы тестирования в GitHub, чтобы поддерживать понятную историю версий и возможности отката.
• Документ для ясности и цели: Записывайте только то, что помогает вам и вашим заинтересованным сторонам понять ход тестирования и его результаты.
  Пример: Включайте сводные отчеты по тестированию, в которых указываются пройденные, неудачные и заблокированные тестовые случаи для анализа руководством.
• Используйте стандартные шаблоны: Используйте единый формат (например, шаблоны Excel или Word), чтобы упростить создание и просмотр документации.
  Пример: Используйте стандартный «Шаблон тестового случая» с полями для идентификатора, описания, предварительных условий и ожидаемых результатов.
• Централизованное хранение документов: Храните все документы, связанные с проектом, в одном доступном месте, чтобы члены команды могли легко ссылаться на них или обновлять их.
  Пример: Храните тестовые артефакты в общем хранилище. Google Drive папка, доступная всей команде QA и разработчиков.
• Включите достаточно подробностей: Избегайте неопределенной или неполной информации; подробная документация улучшает понимание и сокращает количество ошибок при выполнении теста.
  Пример: Вместо «Проверка имени пользователя» напишите «Проверка имени пользователя с действительными учетными данными успешно перенаправляет на панель управления».

Когда следует создавать тестовую документацию для тестирования программного обеспечения?

Вот некоторые ключевые моменты, когда следует создавать тестовую документацию для тестирования программного обеспечения:

• Фаза планирования: Перед началом выполнения теста необходимо четко определить область, цели и стратегию тестирования.
• Подготовка к тесту: В ходе планирования испытаний эффективно устанавливать сроки, ресурсы и требования к окружающей среде.
• Анализ требований: После анализа требований необходимо обеспечить полный охват функциональных и нефункциональных спецификаций.
• Стандартизация дизайна: Перед разработкой тестовых случаев необходимо стандартизировать форматы и обеспечить прослеживаемость всех документов.
• Документация сценария: В процессе разработки теста документировать сценарии, входные данные, ожидаемые результаты и детали тестовых данных.
• Готовность к исполнению: Перед выполнением теста проверить готовность тестовой среды, инструментов и точность документации.
• Оценка после: После тестирования зафиксировать результаты, дефекты и извлеченные уроки для улучшения процесса.

Какие типы шаблонов необходимы для тестовой документации?

Вот некоторые шаблоны, которые вам понадобятся для тестовой документации при тестировании программного обеспечения:

Имя Шаблона	Инструменты
Шаблон плана тестирования	Microsoft Word, Google Docs, или Confluence для совместного редактирования и контроля версий
Шаблон тестового примера	TestRail, Zephyr (в JIRA), Xray или Excel/Google Sheets для структурированного управления тестированием
Шаблон тестового сценария	JIRA, TestLink или Google Sheets для документирования условий тестирования высокого уровня
Шаблон матрицы прослеживаемости требований (RTM)	Excel, Google Sheets или TestRail для сопоставления требований с тестовыми случаями
Шаблон отчета о дефектах	JIRA, Bugzilla или Azure DevOps для регистрации и отслеживания дефектов
Шаблон отчета о сводке испытаний	Слияние, Google Docs или TestRail для компиляции результатов тестирования и анализа

Плюсы и минусы тестовой документации

Плюсы

• Основная цель создания тестовой документации — уменьшить или полностью устранить любую неопределенность, связанную с тестированием. Это помогает устранить неоднозначность, которая часто возникает при распределении задач.
• Документация не только предлагает системный подход к тестирование программного обеспечения, но он также служит учебным материалом для новичков в процессе тестирования программного обеспечения.
• Демонстрация тестовой документации и демонстрация зрелого процесса тестирования является хорошей маркетинговой и коммерческой стратегией.
• Тестовая документация поможет вам предложить клиенту качественный продукт в установленные сроки.
• In Программная инженерияТестовая документация также помогает настроить или преобразовать программу с помощью конфигурационного документа и руководств оператора.
• Тестовая документация поможет вам повысить прозрачность отношений с клиентом.

Минусы

• Стоимость документации может превзойти ее ценность, поскольку она требует много времени.
• Зачастую его пишут люди, которые не умеют хорошо писать или не знают материал.
• Отслеживать изменения, запрошенные клиентом, и обновлять соответствующие документы утомительно.
• Плохая документация напрямую отражает качество продукта, поскольку может возникнуть недопонимание между клиентом и организацией.

Распространенные ошибки, которых следует избегать в тестовой документации

Вот наиболее распространенные ошибки, которых следует избегать в тестовой документации:

1. Избегайте написания неясных или двусмысленных описаний тестовых случаев.
2. Не пропускайте документирование предварительных условий и зависимостей тестирования.
3. Никогда не забывайте указывать ожидаемые результаты для каждого теста.
4. Избегайте несоответствий в форматировании различных тестовых документов.
5. Не используйте неопределенные или неизмеримые цели теста.
6. Никогда не пренебрегайте контролем версий при обновлении тестовой документации.
7. Избегайте дублирования информации в нескольких тестовых артефактах.
8. Не пренебрегайте проверкой документации на точность и полноту.

FAQ