Лидеры в главномНаше образование для надежного и успешного будущего


На главнуюКарта сайтаКонтакт
Быстрая проверка пользовательской документации вашего продукта | Статьи | ННКИ

Быстрая проверка пользовательской документации вашего продукта

06.04.2016

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

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

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

Общая структура

  • Есть ли у документации заголовок, из которого однозначно понятно, о чем она?
  • Есть ли в ней содержание? Ссылки в содержании указывают на правильные страницы документации?
  • Имеется ли в документации раздел Введение или Обзор , кратко описывающий проблематику, сам продукт и его ключевые функции?
  • Указано ли в документации, к каким версиям продукта она применима?
  • Если в документации используется определенная терминология, имеется ли раздел Глоссарий ?
  • Есть ли в документации раздел Контактная информация , чтобы пользователь мог задать вопросы, ответа на которые он не нашел в документации?
  • Имеется ли основной раздел Руководство пользователя , в котором подробно описываются функции продукта и принципы работы с ним?
  • Если работа продукта может причинить вред пользователю, нанести ему травму ил подвергнуть такому риску, включены ли в документацию разделы Внимание / Осторожно / Опасно ?
  • Структура основного раздела документации выстроена вокруг задач, решаемых пользователем, а не вокруг функций продукта?
  • Если в документации больше 40 страниц, есть ли в ней раздел Указатель?

Верстка и оформление

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

Стиль

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

Информация

  • Все ли функции, режимы работы, задачи и возможности продукта раскрыты в документации?
  • Все имена и обозначения точны и одинаковы во всех разделах документации?
  • Имеются ли ссылки из одного раздела документации в другой, когда это уместно? Работают ли эти ссылки?
  • Если в документации есть внешние ссылки, работают ли они? Актуальны ли они?
  • Контактная информация точна и актуальна?
  • А каждом разделе имеются примеры, иллюстрации, видео и другие материалы, помогающие пользователю понять информацию и применить ее в своей работе.
  • Если продукт требует определенных сведений для работы с ним, включает ли документация такие сведения или ссылку на них?
  • Документация предвосхищает проблемы, с которыми пользователь может столкнуться во время работы с продуктом, и предлагает пути их решения.
  • Документация предвосхищает вопросы, которые пользователи могут задать, и предлагает ответы на них в тексте документации или в отдельном разделе.
  • Если существуют определенные требования к стилю и оформлению документации в данной сфере, соответствует ли документация этим требованиям? (ISO 9001, Microsoft Guidelines, и др..)

Заключение

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

Вы можете дополнять и расширять этот список. Мы будем рады, если вы поделитесь вашими собственными чек-листами и методиками в комментариях ниже. Спасибо.

Об авторе

Журавлев Денис, руководитель проекта Dr.Explain (http://www.drexplain.ru) - программы для ,быстрого написания пользовательской и справочной документации. За более, чем 15 лет работы в области софтостроения прошел путь от простого разработчика до руководителя IT-компании. В настоящее время основной фокус интересов: UI & UX - сценарии, инструменты поддержки и взаимодействия с пользователями, интерфейсы, бизнес-модели в IT.