qalight
Центр подготовки
IT специалистов

База знаний

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

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

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

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

И так, начнем:

• Полнота и соответствие действительности. Любая документация должна содержать описание именно той функциональности, которая присутствует в приложении. И данное описание должно касаться абсолютно всей функциональности, а не только наиболее значимой.

• Навигация. И не просто навигация, а удобная навигация. У пользователя никогда не должно возникать проблем с поиском необходимой ему информации. Все деревья файлов, закладки и прочее должны быть на видном месте сразу, как пользователь открывает документ. Алфавитный указатель, поиск – должно присутствовать все, что поможет найти решение или описание проблемы.

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

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

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

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

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

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