Всё для технического документирования
+7 (495) 001-00-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Советы и хитрости: 10 способов для определения пригодности документации

19.08.2013

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


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

Способы определения пригодности документации, приведённые в этой статье, были навеяны десятью основными принципами для пригодного дизайна, разработанными Джейкобом Ниэлсеном (Jakob Nielsen) и Рольфом Моличем (Rolf Molich). Тем не менее, мне потребовалось адаптировать большинство из них, основываясь на собственном опыте оценки пригодности документации.

Подготовка к оценкам пригодности документации

Перед тем, как оценивать свою документацию, выберите такую цель пользователя, о которой вы знаете, что многие пользователи захотят её достичь с помощью программного обеспечения. Хорошая идея – убедиться, что эта цель, кроме того, что подходит для типичных пользователей, также может быть целью организации в отношении данного продукта. Например, целью пользователя в компании, которая производит программное обеспечение для моделирования, может быть: «Я хочу смоделировать контроллер».

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

Способы оценки пригодности документации

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

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

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

2. Ориентация

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

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

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

4. Выполнение задачи

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

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

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

6. Обнаружение и исправление ошибок

Пользователи должны иметь возможность узнать, как обнаружить проблему, исправить её и, возможно, предотвратить её в будущем.

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

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

8. Минималистическое писательство

Разделы не должны включать нерелевантную информацию. Каждый дополнительный кусок информации в разделе соперничает с релевантной информацией, что снижает находимость релевантной информации.

9. Связность и стандарты

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

10. Интеграция с программным обеспечением

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

Источник: Tips and Tricks: 10 Heuristics for Evaluating Documentation Usability

Тэги: , ,

< Вернуться к списку публикаций

Облако тегов