10 эвристик для оценки удобства использования (юзабилити) вашей документации

Перевод: Журавлев Денис

Адаптированный перевод оригинальной статьи:
"Tips and Tricks: 10 Heuristics for Evaluating Documentation Usability", Ana Arel

Эта статья была впервые опубликована в декабре, 2012 года. Сегодня, даже если вы полностью перешли на online-документацию, эти эмпирические правила остаются хорошим подспорьем при оценке качества документации.

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

Эвристики юзабилити документации, описанные в этой статье, основываются на десяти основных принципах юзабилити в дизайне, разработанных Jakob Nielsen и Rolf Molich в 1990 году. Однако мне пришлось переработать многие из них на основе своего опыта по оценке качества документации.

Подготовка к оценке юзабилити документации

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

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

Эвристики для оценки юзабилити документации

Используйте эти эвристики для достижения цели так же, как это делали бы пользователи при решении своих задач в вашем программном продукте. Для каждой эвристики обязательно фиксируйте места и ситуации, которые вызвали проблемы. Объясняйте, в чем были эти проблемы. Фиксируйте свои мысли о задачах, которые пытались решить пользователи, их мнения до и после работы. Сопровождайте заметки копиями экранов (скриншотами). Также отмечайте места, где проблем не возникло для того, чтобы не трогать эти фрагменты при последующих переработках и правках.

1. Поиск и навигация

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

2. Ориентирование

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

3. Принятие решений

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

4. Решение задач

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

5. Обобщение задач

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

6. Диагностика ошибок и устранение их последствий

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

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

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

8. Писательский минимализм

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

9. Согласованность и стандарты

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

10. Интеграция с программным продуктом

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