Тестирование документации - Documentation testing

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

Описание

Тестирование документации включает планы, результаты и тестирование системы или системного компонента. Он включает спецификации тестовых примеров, планы тестирования, процедуры тестирования, отчеты и журналы тестирования. Речь идет о тестировании всех документов, устанавливающих, определяющих, объясняющих и сообщающих или подтверждающих требования, выполняемые процедуры и результаты. Тестирование документации начинается с самого начала самого первого процесса разработки программного обеспечения, чтобы быть наиболее экономичным.[2] Тестирование документации включает проверку орфографии и грамматики на предмет двусмысленности или несоответствия между тем, какие функции он выполняет, и тем, что он должен делать.

Документация по продукту - важная часть конечного продукта.[2] Плохая документация может повлиять на товар или репутацию компании.[3]

Документация - это тестирование всех документов, созданных до и после тестирования программного обеспечения.[4] Любая задержка с проверкой документа приведет к увеличению стоимости.[5] Некоторые общие артефакты, связанные с разработкой и тестированием программного обеспечения, могут быть указаны как тестовые примеры, планы тестирования, требования и матрицы прослеживаемости.

Ключевые области

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

С проблемами документации можно справиться формально, точно так же, как и с проблемами кодирования.[6] Инструменты отчетов о дефектах и ​​инструменты отслеживания являются распространенными решениями для обработки дефектов точно так же, как они обрабатываются в коде.

Смотрите также

Рекомендации

  1. ^ «Что такое тестирование документации? - Офшорное тестирование программного обеспечения с помощью QATestLab».
  2. ^ а б «Что такое тестирование документации при тестировании программного обеспечения?».
  3. ^ «Почему документация важна при тестировании программного обеспечения? - Классы тестирования программного обеспечения». softwaretestingclass.com. 26 ноября 2013 г.
  4. ^ https://www.cs.drexel.edu/~spiros/teaching/SE320/slides/documentation-testing.pdf
  5. ^ Компания, DIANE Publishing (апрель 1994 г.). Руководство по пониманию тестирования безопасности и тестовой документации в доверенных системах. Издательство ДИАНА. ISBN  978-0-7881-0699-6.
  6. ^ Гупта, Йогиндер Натх. «Новая публикация документации, посвященная важному действию при тестировании программного обеспечения».