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

В современном российском мире ИТ можно выделить 2 основных подхода к разработке документации программного обеспечения:

  1. Разработка документации в соответствии государственными стандартами Российской Федерации. В данную категорию попадают все ИТ-проекты для учреждений госсектора и предприятий, взаимодействующих с данными учреждениями. Разработка документации выполняется строго в соответствии с ГОСТ 2, 19 и 34 серии.
  2. Разработка документации в соответствии с внутренними стандартами Заказчика. В данном случае разработка документации регламентируется внутренними правилами Заказчика, которые могут быть построены на базе ГОСТ, ISO/IEC или собственной методологии.

Каждый из указанных выше подходов подразумевает, что для успешной сдачи ИТ-проекта Заказчику, Исполнитель должен предоставить, в том числе, комплект технической документации, однако зачастую понятие «Качественная документация» в ИТ-проектах явным образом не определено.

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

Комплекс мероприятий по контролю качества документации называется «Тестирование документации». Тестирование документации выполняется с целью:

  • Минимизации рисков несоответствия фактически реализованной функциональности информационной системы (ИС) и функциональности, описанной в документации. Наличие таких дефектов в документации повышает вероятность провала приемочных испытаний ИС, либо приводит к значительному увеличению трудоёмкости и длительность приёмки ИС.
  • Минимизации рисков приемки в эксплуатацию ИС с некачественной документацией. Нередко документацию в ИТ-проектах разрабатывают лишь с одной целью – успешно пройти приемочные испытания, не задумываясь о потребностях конечных пользователей документации: аналитиков, пользователей ИС, технических писателей, руководителей проектов, специалистов технической поддержки, тестировщиков.

Примеры типичных дефектов, снижающих качество и ценность документации:

  • требования Технического задания недостаточно детализированы, возможно их неоднозначное толкование;
  • отсутствие определений для применяемых в документации терминов и сокращений;
  • противоречие положений документа друг другу и положениям других документов;
  • несоответствие требованиям ГОСТ в области оформления технической документации (ГОСТ 2.601-2013).

Если Заказчик оплачивает разработку ИС, то в итоговую стоимость уже включена разработка документации, поэтому вполне логично, что Заказчик должен требовать качественного результата и иметь возможность его проконтролировать, ведь помимо успешного приема ИС в эксплуатацию качественная документация может обеспечить достижение следующих бизнес-целей:

  • снижение трудозатрат на техническую поддержку: снижается общее количество обращений пользователей, а также снижаются сроки поиска администраторами ответов в документации
  • сокращение сроков обучения новых пользователей;
  • функциональное тестирование ИС: чем подробнее функциональность описана в документации, тем проще её потом будет протестировать в полном объёме;
  • сокращение операционных затрат на разработку новой функциональности ИС за счет сокращения сроков сбора информации о текущей функциональности и минимизации накладных расходов, возникающих из-за некачественного описания требований в документации.

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

  • заказчик выполняет приемку результатов контракта на разработку ис, заключенного с подрядчиком, в том числе техническую документацию. необходимо выполнить независимую экспертизу документации, разработанной подрядчиком: оценить пригодность документации для проведения приемки ИС, а также качество документации в целом.
  • Заказчик регулярно принимает в эксплуатацию новые релизы ИС, необходимо проконтролировать качество документации для каждого нового релиза.
  • заказчик регулярно проводит конкурсы по закупке услуг по разработке ИС. ввиду необходимости подготовки большого объёма закупочных документов и отсутствия у заказчика специалистов нужной квалификации в достаточном количестве, для выполнения работ привлечен подрядчик – специализированная организация. заказчику необходимо проконтролировать качество разработанной подрядчиком документации: пригодность документации для проведения конкурса в соответствии с целями и задачами Заказчика.

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

Сильной стороной компании «Перфоманс Лаб» как поставщика услуг по тестированию документации является наличие Единой методики контроля качества документации. Данная Методика – не просто формально разработанный документ, это унифицированный механизм, позволяющий в сжатые сроки наиболее полно проверить документ на соответствие разнообразным критериям качества. По сути Методика является максимально формализованным чеклистом, содержащим набор проверок (набор правил, которым документ должен соответствовать). Выполняя проверку посредством такого чеклиста значительно снижается вероятность пропустить ошибку, повышается качество тестирования документации, а именно:

  • Все правила в Методике максимально детализированы и дифференцированы, что исключает их некорректную трактовку сотрудниками, проводящими тестирование документации.
  • Имеются наборы правил, адаптированных под документы различного типа и комплекты документов, что позволяет оптимизировать процесс и снизить сроки тестирования, облегчает передачу знаний на проекте.
  • Все правила ссылаются на нормативный документ, таким образом, результат проверки выглядит более понятным для Заказчика.
  • формат оформления правил проверки в методике предполагает минимум действий по заполнению: нужно только указать соблюдаются ли в документе требования правила (да/нет) и если обнаружены несоответствия – указать номер страницы. Таким образом, снижается трудоемкость оформления отчётной документации – выполняем проверку по всем правилам из Методики и получаем готовый отчёт.

Об авторе

Алексей Характеров — ИТ-специалист со стажем более 5 лет. Алексей является техническим писателем компании Перфоманс Лаб — глобальной компании, специализирующейся на тестировании и обеспечении качества ПО. Основное направление деятельности — технический пресейл.