Тестирование документации
Тестируем любые виды документации, как технической так и пользовательской. Проверяем актуальность, корректность, читаемость, непротиворечивость и выдаем заключение о качестве и рекомендации по его улучшению
Как мы это делаем?
Как пользовательская, так и техническая документация должна соответствовать определенным критериям качества, таким как корректность, однозначность и полнота. Чтобы это проверить, в зависимости от того какую именно документацию нужно проверить применяются различные подходы.
По технической документации, такой как технические задания, спецификации, требования и другие — должно создаваться корректное представление о будущей системе, т.к. именно по этой информации в дальнейшем будут приниматься решения о жизни продукта.
По пользовательской документации, такой как пользовательские инструкции, руководства для администраторов и иные описывающие систему документы, в дальнейшем конечные пользователи будут знакомиться с системой и использовать ее.
Для чего нужно тестировать документацию?
Например, в ходе написания требований для нового приложения, была допущена ошибка в логике работы, из-за чего менялся основной принцип использования данного приложения. Если бы такая ошибка не была выявлена на этапе тестирования требований, а была бы отправлена в реализацию, то полученный функционал отличался бы от того, который нужен заказчику.
В рамках тестирования требований и проведения необходимых процедур, данный дефект был обнаружен и исправлен, что позволило существенно сократить время и стоимость исправления данного дефекта на будущих этапах.
Актуальность и понятность
При первом выпуске программного обеспечения, для пользователей была составлена краткая инструкция для, по которой предполагалось быстрое ознакомление с основной функциональностью ПО и скорое начало работы над ней. Однако даже для первой версии, некоторые пользователи путались в системе, т.к. некоторые пункты инструкции были написаны достаточно абстрактно.
По мере развития приложения, данную инструкцию не меняли и в итоге это привело к тому что порог входа для начала использования прилжоением оказался очень велик и новые пользователи все равно спрашивали помощи у своих коллег, что вызывало дополнительные временные затраты.
В тестирования данной инструкции были найдены разделы, которые требуют уточнения и после устранения всех замечаний — понимание приемов использования приложения стало доступно для всех.
Какая польза от тестирования документации?
Благодаря введению этапа тестирования документации в состав процесса обеспечения качества для любого программного продукта, получают следующие результаты:
