Меню

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

Примеры и рекомендации удобных инструкций

Снова здравствуй, уважаемый хабралюд!

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

Всем, кому интересно, прошу под хабракат.

Принцип Keep It Simple Stupid хорошо известен в программировании, но почему-то его редко используют для написания инструкций и руководящих документов, предпочитая растекаться мыслею по древу. В 70% ситуаций эта документация необходима только для того, что бы отмахаться от наших бодрых регуляторов, но при этом забывают, что с этой документацией придётся работать, причём не всегда технически подкованным и грамотным в области информационной безопасности людям.

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

1. Старайтесь разделять инструкцию для пользователей от инструкции для администраторов и офицеров безопасности. причём первые не должны содержать ссылок на вторые (они могут содержать отсылки друг к другу).
2. Делайте пошаговые инструкции, вида «взял и сделал». То есть инструкции должны описывать алгоритм действий того, на кого она направлена.
3. Каждый пункт описывайте, как отдельное действие с обязательным указанием ответственного и контактами, если они необходимы.
4. Для большей наглядности можете дополнительно нарисовать в инструкцию блок-схему действий. Это поможет пользователю наглядно понять и оценить действия, так же и вам доступно объяснить алгоритм при обучении.
5. Психологический момент — инструкция будет плохо выполняться и работать, если пользователям понятно и доступно не объяснят алгоритм на пальцах и примерах. Поэтому — НЕ ЗАБЫВАЙТЕ ПРО ОБУЧЕНИЕ!

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

Ниже приведен пример инструкции по заведению аккаунта пользователя в корпоративной сети.
image

Clear screen/clear desk

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

Хорошим примером из лучших практик здесь является политики чистого стола и чистого экрана. Их можно описать так же, как я приводил пример ранее, но это будет выглядеть немного глупо, так как действия там простейшие. Лучше просто сделать набором правил:
image

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

Источник

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

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

Vlad Golovach

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

Источник



Как писать понятные инструкции для товаров: руководство для копирайтеров

Инструкция – справочный документ, где собраны правила эксплуатации товара. Это может быть руководство пользователя бытовой техники, указания к применению лекарственного препарата, статья в разделе FAQ или текст на пачке риса. Продавец обязан предоставить покупателю информацию о товаре согласно статье 10 закона России «О защите прав потребителей».

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

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

Хотите получать дайджест статей?

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

Виды инструкций

По содержанию инструкции бывают:

  1. Описательные. Цель описательной инструкции – познакомить покупателя с товаром: рассказать о полезных функциях смартфона, возможностях сервиса, материалах оконного профиля или применении битумной мастики.

«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».

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

«Включите стиральную машину с помощью кнопки СТАРТ.

Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

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

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

Еще инструкции разделяются по формату:

  • текстовые;
  • видеоинструкции;
  • скринкастинг – запись действий с экрана компьютера;
  • инфографика – подборка иллюстраций для быстрой передачи сути;
  • FAQ – справочный раздел сайта для ответов на популярные вопросы.
Читайте также:  Противопоказания к применению препарата ЛЕВАМИЗОЛ 75

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

Правила составления текстовых инструкций

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

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

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

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

Структура

Типовая инструкция включает следующие разделы:

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

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

Внимательным читателям! Дарим скидку 35 % на оплату любого тарифа курса « Коммерческий автор » от онлайн-университета TeachLine. Чтобы активировать скидку, перейдите на страницу курса, прокрутите вниз, чтобы появилось всплывающее окно, и нажмите кнопку «Получить».

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

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

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

Для этого необходимо перейти в режим записи видео.

Перейдите в режим записи видео.

Ламинированное покрытие нужно протирать обычными моющими средствами.

Протирайте ламинированное покрытие обычными моющими средствами.

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

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

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

Эта надпись говорит о вероятной поломке механизма.

Эта надпись говорит о поломке механизма.

Сбор данных скорее всего займет 10 минут.

Сбор данных займет 10 минут.

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

Удерживайте кнопку «Пуск» до появления желтой индикации на экране. Затем выберите в меню режим «Блок».

Для регулировки створки вам потребуется шестигранник, шлицевая отвертка и монтажный клин.

Для регулировки створки вам понадобятся:

Не используйте синонимы одного и того же термина. Они могут означать разные вещи. Читатель должен понять смысл, а не оценить словарный запас автора.

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

Номинальная мощность микроволновки – 700 Вт.

Номинальная мощность микроволновой печи – 700 Вт.

Граната автомобиля передает крутящий момент на ось колеса.

Шарнир равных угловых скоростей (ШРУС) автомобиля передает крутящий момент на ось колеса.

Подберите читаемый шрифт текста. Шрифты с засечками (Times New Roman, Georgia) имеют небольшие черточки по краям линий. Они подходят для объемных печатных документов в 12 размере. Шрифты без засечек (Arial, Verdana) хорошо читаются на электронных документах.

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

Допустимое напряжение в сети от 215 до 230 Вольт.

Допустимое напряжение в сети от 215 до 230 Вольт.

Иллюстрации

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

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

Ну и в завершение, несколько полезных статей на тему дизайна:

Источник

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

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

Vlad Golovach

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

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

Источник