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

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

Руководство пользователя (англ. user guide или user manual), руководство по эксплуатации, руководство оператора — документ, назначение которого — предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.

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

Содержание

Содержание

Типичное руководство пользователя содержит:

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

Стандарты

Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

Источник

Корпоративные хранилища данных. Интеграция систем. Проектная документация.

РД 50-34.698-90 Руководство пользователя (пример оформления)

Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 50-34.698-90.

Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».

Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».

Ниже приведен состав руководства пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделен вертикальной чертой).

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

1. Введение

В разделе «Введение» указывают:

1.1. Область применения

Требования настоящего документа применяются при:

1.2. Краткое описание возможностей

Информационно-аналитическая система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации технологии принятия тактических и стратегических управленческих решений конечными бизнес-пользователями на основе информации о всех аспектах финансово-хозяйственной деятельности Компании.

ИАС КХД предоставляет возможность работы с регламентированной и нерегламентированной отчетностью.

При работе с отчетностью используется инструмент пользователя Oracle Discoverer Plus, который предоставляет следующие возможности:

1.3. Уровень подготовки пользователя

Пользователь ИАС КХД должен иметь опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet Explorer, Oracle Discoverer, а также обладать следующими знаниями:

Квалификация пользователя должна позволять:

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

2. Назначение и условия применения Oracle Discoverer Plus

В разделе «Назначение и условия применения» указывают:

Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по показателям деятельности, а также для углубленного исследования данных на основе корпоративной информации хранилища данных.

Работа с Oracle Discoverer Plus в составе ИАС КХД возможна всегда, когда есть необходимость в получении информации для анализа, контроля, мониторинга и принятия решений на ее основе.

Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям с установленными правами доступа.

3. Подготовка к работе

В разделе «Подготовка к работе» указывают:

3.1. Состав и содержание дистрибутивного носителя данных

Для работы с ИАС КХД необходимо следующее программное обеспечение:

3.2. Порядок загрузки данных и программ

Перед началом работы с ИАС КХД на рабочем месте пользователя необходимо выполнить следующие действия:

3.3. Порядок проверки работоспособности

Для проверки доступности ИАС КХД с рабочего места пользователя необходимо выполнить следующие действия:

В случае если приложение Oracle Discoverer Plus не запускается, то следует обратиться в службу поддержки.

4. Описание операций

В разделе «Описание операций» указывают:

Для каждой операции обработки данных указывают:

В описании действий допускаются ссылки на файлы подсказок, размещенные на магнитных носителях.

4.1. Выполняемые функции и задачи

Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:

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

Ниже приведено описание пользовательских операций для выполнения каждой из задач.

Задача: «Визуализация отчетности»

Операция 1: Регистрация на портале ИАС КХД

Условия, при соблюдении которых возможно выполнение операции:

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

Основные действия в требуемой последовательности:

Ресурсы, расходуемые на операцию:

Операция 2: Выбор отчета

Условия, при соблюдении которых возможно выполнение операции:

Успешная регистрация на Портале ИАС КХД.

Основные действия в требуемой последовательности:

1. В появившемся окне «Мастер создания рабочих книг» поставить точку напротив пункта «Открыть существующую рабочую книгу».

2. Выбрать нужную рабочую книгу и нажать кнопку «Откр.»:

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

Ресурсы, расходуемые на операцию:

Задача: «Формирование табличных и графических форм отчетности»

Заполняется по аналогии.

5. Аварийные ситуации

В разделе «Аварийные ситуации» указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.

В случае возникновения ошибок при работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к ответственному Администратору ИАС КХД.

6. Рекомендации по освоению

В разделе «Рекомендации по освоению» указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

Рекомендуемые курсы обучения:

В качестве контрольного примера рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в п. 4.2. настоящего документа.

Источник

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выводы

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

Источник

Руководство пользователя согласно требованиям ГОСТ

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

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

Руководящими стандартами для создания документа Руководство пользователя могут являться как РД 50-34.698-90 в п.п. 3.4. «Руководство пользователя», так и ГОСТ 19.505-79 «Руководство оператора. Требования к содержанию и оформлению». Ниже для сравнения приведены структуры документа согласно двум перечисленным стандартам.

ГОСТ 19.505-79 Руководство оператора

Введение

Уровень подготовки пользователя

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

Назначение и условия применения

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

Назначение программы

Условия, при которых обеспечивается применение программы

Условия выполнения программы

Подготовка к работе

Выполнение программы

Состав и содержание дистрибутивного носителя данных

Порядок загрузки данных и программ

Порядок загрузки, запуска и завершения программы

Описание операций

Описание функций

Описание всех выполняемых функций, задач, комплексов задач, процедур

Описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур

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

Сообщения оператору

Рекомендации по освоению

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

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

«Корпоративный интранет портал предназначен для повышения корпоративной культурыр организации эффективного взаимодействия сотрудников.

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

Условия применения системы

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

Подготовка системы к работе

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

Описание операций

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

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

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

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

4.1.1 Создание проекта
Для того чтобы создать Проект необходимо на панели «…» нажать на кнопку «…» и в появившейся форме заполнить следующие поля:

Следующие поля заполняются автоматически:

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

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

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

Аварийные ситуации

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

На нашем сайте вы можете скачать шаблон документа Руководство пользователя, выполненный в формате Word.

Источник

Руководство пользователя. Советы для составления

Существует множество видов предоставления справочной информации пользователю – это и FAQ (frequently asked questions, часто задаваемые вопросы) и онлайн справка и руководство пользователя (user guide) и популярные сегодня подсказки (coachmarks, см. пример ниже), обучающие видео и другие.

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

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

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

1. Стандарты

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

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

Также может оказаться полезной книга Юрия Кагарлицкого MetaGuide. Руководство для разработчиков технической документации к программному обеспечению.

2. Структура

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

Хорошее руководство пользователя должно содержать:

Также руководство пользователя может содержать:

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

3. Пользователи

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

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

Уважайте пользователей системы, не пишите инструкции в пренебрежительном стиле.

4. Особенности изложения

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

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

Для составления хорошего документа пригодятся знания грамматики и немного психологии.

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

Хорошо: In File menu, select Save item.
Хуже: Select Save item from File menu.

4.2 Используйте повелительное наклонение, не употребляйте вежливые обороты (please, could и т.д.) — излишняя вежливость именно здесь будет помехой.

Хорошо: Click Logout to log out current user account from the system.

Хуже: It is needed to click Logout to log out current user account from the system.

Хуже: If user wants to log out current user account from the system (s)he needs to click Logout.

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

Хорошо:
To create project:

Хуже: To create project click the Create button on toolbar, on the Create Project overlay fill in all mandatory fields, click the Save button to save the project.

4.4 Не используйте будущее или прошлое время. Например, часто встречаются руководства, в которых реакция системы на действие пользователя передается фразами, сформулированными в будущем времени. У ПО нет прошлого или будущего: всё случается в настоящем как прямой результат конкретного действия пользователя. Как только событие случается, ПО реагирует.

Хорошо: When user clicks the Start button, the program starts the process.

Хуже: When user clicks the Start button, the program will start the process.

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

Например, глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи мыши, а «hit» вообще является жаргонным словом.

Разумеется, орфографические ошибки недопустимы.

4.6 Не используйте синонимы для одного и того же термина. В IT литературе на английском (или любом другом) языке есть стандартный набор глаголов, обозначающих действия (click, double-click, select, type, press и т.д.) и такой же стандартный набор названий элементов управления. Определитесь с терминологией и придерживайтесь ее в рамках всего документа.

Например, не допускайте, чтобы в одной части документа выпадающий список назывался dropdown, а в другой точно такой же элемент – combobox или dropdown list. Это путает пользователя.

4.7 Разумно используйте сокращения и исключите жаргон.

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

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

5. Внешний вид

5.1 Продумайте стиль документа. Это может быть корпоративный шаблон или цветовая схема ПО или специально сделанный для документа дизайн.

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

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

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

6. Поддержка

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

Заключение

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

Помните главное: документ должен помогать пользователям.

Статью подготовила

Тарасюк Надежда, участник сообщества analyst.by,

Источник

• ← Ротационный подвывих атланта у детей что это
• Плакаты с машинами на стену →