Тестовая документация и ее важность

Документация по тестированию программного обеспечения имеет неоценимое значение для любой организации, поскольку она облегчает процесс тестирования. В этой статье мы расскажем, что именно она собой представляет, объясним ее важность и перечислим некоторые виды тестирования.

Тестирование является неотъемлемой частью запуска продукта.

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

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

Друзья, поддержите нас вступлением в наш телеграм канал QaRocks. Там много туториалов, задач по автоматизации и книг по QA.

Содержание:

• Что такое тестовая документация ?
• Почему она так важна?
• Виды тестовой документации
• Советы по составлению тестовой документации
• Заключение
• Часто задаваемые вопросы

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

Тестовая документация ПО описывает артефакты, созданные до и во время тестирования. Другими словами, это запись стратегии, целей, процессов, метрик и результатов работы команды тестирования.

На приведенном ниже графике показаны некоторые примеры тестовой документации (выделены красным цветом) и время их возникновения в жизненном цикле тестирования ПО.

Это лишь некоторые ее виды – исчерпывающий список будет представлен позже. Тем не менее, эта наглядная схема дает общее представление.

Тестирование программного обеспечения – это формальный компонент разработки ПО, его не следует ограничивать только кратким документированием.

В конце концов, документация облегчает и подтверждает планирование, проверку и внедрение тестов.

Однако степень формальности зависит от принятой в вашей компании практики, уровня зрелости разработки и типа тестируемого программного обеспечения.

Почему она так важна?

Документировать процессы тестирования стоит на протяжении всей работы, поскольку это дает множество преимуществ. Однако главным плюсом документации по тестированию является ее детальный анализ.

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

После выявления болевых точек можно внедрить новые подходы для повышения производительности. Постоянный мониторинг помогает непрерывно совершенствовать тестирование.

Том ДеМарко, известный американский инженер-программист, прокомментировал это следующим образом:

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

Затем процедуры можно редактировать для будущих улучшений.

Тестовая документация также неоценима с финансовой точки зрения. Представьте себе, что ваш сервер неправильно отображает или маршрутизирует страницы, а ваш сайт/приложение не загружает нужные дисплеи.

Без тестовой документации на решение проблемы уйдут часы, а отделу маркетинга придется заниматься устранением повреждений, что приведет к резкому росту затрат.

Однако в качественной тестовой документации должна быть подробно описана причина ошибки и предложены возможные решения.

Таким образом, она поможет решить будущие проблемы, выступая в качестве ориентира.

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

По мере реализации проекта затраты растут. Поэтому крайне важно правильно фиксировать процессы тестирования и минимизировать последующие риски.

Помимо экономических последствий, тестовая документация помогает избежать возникновения информационной изоляции. Разработчики и команды контроля качества нередко не знают, над чем работают другие.

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

Более того, наличие единого источника информации снижает вероятность недопонимания, поскольку все команды постоянно ссылаются на документированные процессы.

Так как все возможные характеристики записываются, отслеживать информацию легко.

Это особенно полезно при приеме на работу новых сотрудников, потому что документация может служить учебным материалом.

При наличии большого количества записанной информации ускоряется процесс адаптации сотрудников: не нужно назначать для них менторов. Вместо этого достаточно просто направить их к задокументированным сведениям.

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

Когда все эти тесты должным образом задокументированы, у вас есть кладезь информации, которую можно передать новым сотрудникам.

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

Тестовая документация предназначена для двух различных аудиторий. Во-первых, она обеспечивает команды QA точными данными, что позволяет им легче разрабатывать стратегию и проводить тестирование.

Во-вторых, она позволяет донести информацию о ходе тестирования до сторонних организаций, таких как отдел маркетинга, отдел разработки и, конечно же, владельцев продукта.

Таким образом, ее можно разделить на внутреннюю и внешнюю.

Конечно, существуют различные стандарты и типы документов, все зависит от компании, продукта и заказчика.

Однако в целом наиболее распространена следующая классификация.

Внутренняя тестовая документация

Внутренняя документация состоит из восьми основных типов:

Рассмотрим каждый из них.

• Политика тестирования предусматривает любые правила тестирования, которые необходимо соблюдать; например, могут ли тестировщики использовать частное оборудование или должны использовать только корпоративные устройства и т. д.
• Стратегия тестирования – документ высокого уровня, определяющий, на каких уровнях проекта будет проводиться тестирование. По мере реализации проекта менеджеры используют этот документ для проверки того, все ли идет по плану.
• План тестирования – наиболее полный документ, содержащий всю необходимую информацию, такую как объем тестирования, подходы, участники процесса, ресурсы и ограничения. Он распространяется среди всех членов команды.
• Тестовые сценарии классифицируют интерфейс и работу продукта на модули. Они гарантируют, что все возможные технологические процессы проверяются от начала до конца.
• Тест-кейсы описывают способы тестирования. В них подробно описывается набор условий, входных данных и пошаговых инструкций. Сравнивая текущие ресурсы с желаемым результатом, они определяют, все ли в порядке.
• Тестовые данные – это список данных, которые тестировщики используют при прохождении тест-кейсов, например, медиаконтент, сгенерированные пользователи, статистика и т.п.
• В журнале тестирования перечисляются различные тестовые случаи и записываются результаты тестирования, предоставляющие подробный сводный отчет.
• Матрица трассируемости представляет собой таблицу различных тест-кейсов с указанием требований к ним. С ее помощью тестировщики могут отслеживать прогресс от разработки до написания кода.

Теперь, когда мы изучили, какие виды внутренней документации по тестированию существуют, давайте рассмотрим те, которые в большей степени ориентированы на пользователя.

Внешняя документация

Существует три основных вида внешней тестовой документации:

Мы дадим обзор каждого из трех типов.

• Баг-репорты передают всю информацию об ошибках в программном обеспечении, включая краткое описание проблемы, сведения о степени серьезности и классификации приоритетов. В них также должны быть описаны шаги по устранению ошибки и предложено решение.
• Сводные отчеты о тестировании обобщают результаты цикла тестирования. В них часто указываются стоимость обнаружения ошибок, общая эффективность тестирования, эффективность тестового набора, объем доработок, усилий по аутентификации и т.п.
• В отчете о приемке пользователем излагаются результаты тестирования программного обеспечения. Этот документ передается заинтересованным сторонам, чтобы убедиться в том, что цели разработчиков и заказчиков совпадают, что у них одинаковое видение.

Другими словами, отчет подтверждает соответствие технических характеристик пожеланиям клиентов.

Советы по созданию отличной тестовой документации

Нет смысла делать что-либо наполовину; если тестовая документация плохо оформлена, ее можно было бы и вовсе не писать.

Она представляет ценность для команд обеспечения качества и разработчиков только в том случае, если составлена адекватно.

Убедитесь в том, что ваша тестовая документация качественная. Есть несколько правил, которых следует придерживаться. Они позаботятся о том, чтобы ваши документы были в лучшем виде.

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

Поддерживать в рабочем состоянии

Недостаточно просто написать документацию, сдать ее в архив и больше никогда к ней не обращаться. Напротив, она должна постоянно обновляться.

Это связано с тем, что процесс тестирования программного обеспечения постоянно подвергается изменениям. Также часто меняются требования и приоритеты, что, в свою очередь, влияет на ресурсы, объем тестирования и другие параметры.

Кроме того, если в программное обеспечение добавляется новая функция, она также должна быть протестирована и зафиксирована в документации.

Если о таких изменениях не сообщается, то документация устаревает и становится неактуальной для компании. В этот момент она перестает быть ориентиром.

Поэтому очень важно поддерживать все документы, касающиеся процесса тестирования, в актуальном состоянии.

Одним из способов решения этой задачи является регулярная проверка всех артефактов.

Хранить все в одном надежном месте

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

Вместо этого вся документация должна находиться в одном надежном месте. Это позволит легко находить все необходимое в любое время.

Однако это место при этом не должно быть общедоступным. Безопаснее использовать определенные средства защиты, такие как защита паролем, аутентификация JWT или шифрование данных.

Документационная платформа отвечает обоим требованиям. Все ваши документы будут размещены в централизованной среде, и сотрудники не будут тратить время на их поиск.

Использовать стандартные шаблоны

При составлении тестовой документации лучше всего придерживаться правила простоты. Если этого не требует конкретная ситуация, нет необходимости использовать причудливые инструменты.

Вместо этого старайтесь использовать хорошо известные приложения, такие как Word и Excel. Таким образом, читатели смогут легко получить доступ к документации без установки дополнительного программного обеспечения.

Кроме того, рекомендуется придерживаться одного установленного шаблона.

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

Таким образом, вы не будете тратить лишнее время на оформление.

Если вы не знаете, с чего начать, вы также обратиться к онлайн-ресурсам.

Вот пример шаблона матрицы прослеживаемости:

Готовые шаблоны облегчают составление документации и экономят временные ресурсы.

Делать документацию подробной

Прежде всего, отличная тестовая документация должна быть очень подробной. Программное обеспечение – это многоуровневый процесс, и тестирование ПО – тоже.

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

Рассмотрим отчеты об ошибках.

Однострочное описание ошибки не является достаточным.

Читатели хотят полностью понять суть ошибки, они ожидают сравнения того, что отображается по факту и что должно отображаться по плану.

Кроме того, в отчете должно быть объяснено, как решить проблему, так как сообщение об ошибке без подробностей по отладке мало что значит. Джем Канер прокомментировал это так:

Другими словами, отладка часто зависит от того, насколько подробным является ваш документ.

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

Пользователь Reddit предлагает свой взгляд на тестовую документацию:

Наличие подробной документации значительно облегчает все остальные аспекты тестирования.

Кроме того, если документ составлен очень подробно, это также улучшает его поисковые возможности. Если вы ищете конкретный раздел, будет гораздо проще найти этот сегмент с исчерпывающей информацией.

Например, указание редакций и версий программного обеспечения уже является огромной помощью.

Заключение

В тестовой документации фиксируются все важные аспекты, связанные с этим процессом; Благодаря такому документу у тестировщиков всегда имеется ориентир, на который можно опираться.

Существует множество типов документов, но в целом их можно разделить на внутренние и внешние. Это зависит от аудитории документа.

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

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

‍

Часто задаваемые вопросы

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

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

Зачем она нужна ?

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

Перевод статьи «Software Testing Documentation: What Is It and Why Should You Have It?».