Руководство пользователя для пользователя

Екатерина Филатова, 12.06.2006

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

Очевидны две базовые проблемы. Авторы руководств:

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

Результат соответствующий.

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

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

И с учетом этих представлений создавать текст руководства.

Главными составляющими качества руководства пользователя, безусловно, являются его структура и собственно текст. И от того, насколько эти составляющие отвечают нуждам пользователя, зависит качество всего руководства.

Структура руководства

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

Заглянув в такое руководство и потратив впустую некоторое время, пользователь вряд ли воспользуется им вновь. Поэтому очевидно, что:

  1. Руководство должно в первую очередь иметь простую и четкую структуру, построенную в зависимости от назначения и применения программного продукта. То есть отвечать на вопросы: что это за продукт, кому и когда он нужен, как с ним работать: установка и настройка, перечень решаемых задач и оптимальные способы их реализации, способы решения возможных проблем.
  2. При создании структуры руководства следует исходить из нужд и потребностей пользователя программного продукта, так, чтобы, открыв содержание, пользователь мог без труда найти ответ на искомый вопрос. А обнаружив нужное, получил исчерпывающую информацию, как решить свою задачу, когда и зачем использовать ту или иную функциональность программы.
  3. Поскольку пользователь вряд ли будет полностью читать руководство, а будет лишь просматривать нужные разделы, то каждый раздел должен быть автономен и давать всю информацию по данному вопросу.

Попробуем применить эти принципы к конкретному руководству. Проанализируем структуру руководства пользователя для работы с Автоматизированной информационно-аналитической системой «Библиотека». Его содержание:

  • Введение
  • Программа «Библиотека» позволяет Технические требования Установка программы Особенности работы с модулем «Рабочее место библиотекаря»
  • Описание программы
  • Введение Общая концепция данных в АИАС «Библиотека» С чего начать? Составление списка сотрудников и читателей Источники поступления Оформление поступления Акт поступления Распределение документов по подразделениям и формам индивидуального учета Книга суммарного учета Книга индивидуального учета Поиск и редактирование документов
  • Поиск Редактирование Замена Выбытие Выдача
  • Реестр актов Акт проверки фонда Акт замены Акт выбытия Тетрадь замены документов Словарь Справочник
  • Общие положения Поиск и редактирования Добавление нового описания Указание списка авторов Копирование записи Импорт данных Утилиты по работе с базой
  • План работы Абонемент Классы
  • Создание класса Работа с классами Выдача классам Выдача ученикам Выдача через таблицу Формирование таблицы
  • Статистика Печать Справка

Как видно, структура этого руководства довольно большая и нечеткая, формулировки расплывчаты, разделы дублируют друг друга. Рассмотрим наиболее характерные ошибки и способы их решения:

  1. Целых три раздела: Программа «Библиотека» позволяет, Введение и Общая концепция данных в АИАС «Библиотека» по-разному описывают одно и то же — задачи и возможности программы Библиотека. Зачем дробить и удлинять структуру? Будет проще и логичнее объединить их один раздел.
  2. В разделе Особенности работы с модулем «Рабочее место библиотекаря» можно отметить целых две проблемы. Во-первых, из содержания непонятно, что это за модуль и откуда он взялся. Во-вторых, в разделе описывается не особенность работы с этим модулем, а процесс его установки. Получается, что автор сознательно запутывает пользователя и даже обманывает, заставляя самостоятельно разбираться в проблеме. Эту информацию следует перенести в раздел, описывающий процесс установки.
  3. Раздел Установка программы рассказывает, что данный программный продукт состоит из четырех отдельно устанавливаемых модулей. Как устанавливать эти модули неясно, и лишь информация об установке одного модуля выносится в отдельную главу. Логичнее рассказать пользователю о модулях в разделе, посвященном описанию самой программы, а в разделе Установка рассказать об особенностях установки.
  4. Заголовок Описание программы не совсем уместен, поскольку описание программы есть в начале руководства, далее необходимо рассказать пользователю о том, как собственно работать с этой программой. Получается, что заголовок дезинформирует пользователя. Это явная ошибка.
  5. Все три раздела С чего начать?, Составление списка сотрудников и читателей, Источники поступления повествуют о необходимых настройках программы перед началом работы, а именно: регистрации учреждения, формировании подразделений, форм учета и списка читателей, сотрудников и источников поступления. Эти действия необходимо совершить один раз и затем лишь вносить изменения. Поэтому совершенно непонятно, зачем автор руководства делит эту информацию на разные разделы.
  6. После завершения всех настроек пользователь может начинать работать. Соответственно в руководстве пользователя далее помещается информация, как работать с документами, абонементом и классами, а также вести учет.
  7. Раздел Справочник. Неверное название вводит пользователя в заблуждение. Из содержания неясно, что это и есть База шаблонов библиографических описаний, которая поставляется вместе с программным продуктом, о чем говорится в описании к программе. Пользователь должен знать, что ему не требуется вносить описания вручную, а только пользоваться шаблонами.
  8. Все Акты и Реестр Актов относятся к специальной базе данных учетных форм, списков, реестров, предусмотренной программным продуктом. Об этом также говорится в описании к программе, и логичнее объединить соответствующие главы в один раздел, посвященный работе по учету информации.
  9. Разделы Словарь и Справка вполне можно объединить в раздел Справочная информация или хотя бы перенести Словарь в конец руководства.
  10. И, наконец, не во всех разделах присутствует информация о том, чем этот раздел полезен пользователю, для чего, когда и как лучше его использовать. Это обстоятельство, вкупе с нечеткой структурой и расплывчатыми формулировками, сильно затруднит освоение программного продукта пользователем.

С учетом обозначенных замечаний получаем более простую и логичную структуру руководства:

  • Задачи и возможности программы «Библиотека»
  • Технические требования
  • Установка программы
  • Настройка программы
  • Работа с программой
  • Работа с документами
  • Оформление поступлений Поиск Редактирование Замена Выбытие Выдача Распределение документов по подразделениям и формам индивидуального учета
  • Учет документов
  • Реестр актов Акт поступления Акт проверки фонда Акт замены Акт выбытия Книга суммарного учета Книга индивидуального учета
  • База шаблонов библиографических описаний
  • Поиск и редактирования Добавление нового описания Указание списка авторов Копирование записи Импорт данных Утилиты по работе с базой
  • Планирование работы Абонемент Классы Статистика Печать
  • Справочная информация

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

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

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

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

Краткость и стиль

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

Как применить эти принципы на практике рассмотрим на примерах с типичными ошибками.

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

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

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

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

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

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

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

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

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

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

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

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

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

Элементарные грамматические ошибки или обычные недочеты, как в данном случае — многократное повторение слова «было», не добавят доверия к руководству и его автору.

Выводы

Итак, если руководство пользователя создается для пользователя, а не для описания программного продукта, оно должно отвечать нескольким требованиям:

  • Главная персона в руководстве всегда пользователь и его запросы при работе с данным продуктом. Руководство не должно обманывать его ожидания. Оно должно отвечать на вопросы, а не заставлять читать описания интерфейса программы.
  • Четкость характеристик. Пользователю необходимо ясно объяснить не только как совершить то или иное действие, но и как лучше это сделать, когда лучше, для чего и к чему это приведет. В этом случае пользователь лучше сможет ориентироваться в программном продукте и использовать его по максимуму. Расплывчатые и непонятные формулировки здесь неуместны!
  • Краткость текста. Текст должен быть небольшим и легко читаться. Нужно избегать тяжеловесных форм с многочисленными причастными или деепричастными оборотами, вводными словами и т.д. И нельзя заставлять пользователя читать лишние детали. Пользователь не должен тратить время на длинные и зачастую ненужные описания.
  • Стилистически и грамматически правильный текст. Грамотный текст облегчает восприятие текста и повышает доверие пользователя к руководству.

Show your support

Clapping shows how much you appreciated Влад Головач’s story.