# Руководство пользователя Руководство пользователя – это основной документ в составе эксплуатационной документации на автоматизированную систему (ГОСТ 34). ## Назначение руководства пользователя Цель создания документа заключается в том, чтобы предоставить пользователю возможность самостоятельно решать свои прикладные задачи с помощью системы. Этой цели может служить и введение в предметную область, и ознакомление со всеми возможностями программы, и описание конкретных процедур решения задач, и приведение различных инструкций. Иногда Руководство пользователя больше похоже на справочник, к которому можно обращаться в процессе работы, а иногда – на учебник, который позволяет изучить принципы работы с программой и ее возможности, а затем применять их на практике. ## Состав типового руководства пользователя Конкретный подход к написанию определяется многими факторами: * назначением программы и областью ее применения; * сложностью программы; * количеством разнообразных вариантов использования. Принимая во внимание все различия и особенности, сложно привести структуру любого Руководства пользователя к одному виду. Тем не менее, РД 50-34.698 предлагает нам такой список разделов: * **Введение**, где указывают область применения ПО, краткое описывают его возможности, требуемый уровень знаний пользователя и список документов, которые необходимо изучить помимо настоящего руководства; * **Назначение и условия применения**, где описывают виды деятельности и функции, которые автоматизированы и условия, при соблюдении которых автоматизация используется; * **Подготовка к работе**, где описывают комплектность дистрибутива, порядок установки и загрузки программы, а также способ проверки ее работоспособности; * **Описание операций**, представляет собой основной раздел, где описывают функции программы, процессы работы с данными, выполнение конкретных задач пользователя; * **Аварийные ситуации**, где описывают действия в нештатных ситуациях – сбоях в программе, ошибок в данных и т.д.; * **Рекомендации по освоению**, где приводят методические рекомендации по изучению программы и примеры использования. Данная структура может меняться и дополняться – например, основной раздел часто разбивают на несколько значимых разделов по группам функций или задач, также в современных системах нередко добавляют раздел **Интерфейс пользователя**, где описывают взаимодействие пользователя с программой с примерами и снимками экрана. ## Стандарты для руководства пользователя Наличие Руководства пользователя регламентируется ГОСТ 34.201, а структура и содержание – РД 50-34.698. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства пользователя могут отличаться друг от друга по способу, методике и стилю изложения. ## Примеры ### Назначение системы Данный раздел документа Руководство пользователя должен содержать информацию о назначении системы, ее целях и задачах. >Пример: >«Корпоративный интранет портал предназначен для повышения корпоративной культурыр организации эффективного >взаимодействия сотрудников. >Основной целью Портала является создание единого информационного пространства предприятия и оптимизация работы >сотрудников путем облегчения коммуникаций между ними и оптимизации ряда бизнес-процессов.» ### Условия применения системы Данный раздел документа Руководство пользователя должен включать все те факторы, которые необходимы для корректной работы системы. Здесь можно выделить несколько подразделов: * Требования к аппаратному обеспечению – сюда можно включить требования к конфигурации компьютера пользователя, программное обеспечение необходимое для работы Системы, а также наличие дополнительного оборудования (принтер, сканер и т.п.), если таковое необходимо; * Квалификация пользователя – данный подраздел должен содержать требования к навыкам и знаниям пользователя (пример: «Пользователи должны обладать навыками работы с операционной системой Windows XP»); ### Подготовка системы к работе Данный раздел документа Руководство пользователя должен содержать пошаговую инструкцию для запуска приложения. К этапу подготовки системы к работе можно отнести установку дополнительных приложений (при необходимости), идентификацию, аутентификацию и т.п. ### Описание операций Это основной раздел документа Руководство пользователя, который содержит пошаговую инструкцию для выполнения того или иного действия пользователем. Если работа автоматизированной системы затрагивает целый бизнес-процесс, то в руководстве пользователя перед описанием операций целесообразно предоставить информацию о данном процессе его назначении и участниках. Подобное решение позволяет человеку четко представить свою роль в данном процессе и те функции, которые реализованы для него в системе. Далее в документе Руководство пользователя следует представить описание функций разбитых на отдельные операции. Необходимо выделить подразделы, описывающие функции данного процесса, и действия, которые необходимо совершить для их выполнения. >Пример: >«4.1 Согласование проекта >Данный процесс предназначен для организации работы сотрудников, участвующих в разработке и согласовании >проекта. >Автор проекта создает запись в Системе и прикрепляет пакет необходимой документации, далее проект передается >на согласование руководящими лицами. Руководители после ознакомления с проектом могут подтвердить его или >отправить на доработку Автору. >4.1.1 Создание проекта >Для того чтобы создать Проект необходимо на панели «…» нажать на кнопку «…» и в появившейся форме заполнить >следующие поля: > >Наименование проекта; >Описание проекта; >Следующие поля заполняются автоматически: > >Дата создания проекта – текущая дата; >Автор – ИФО и должность автора проекта.» Руководство пользователя может представлять собой как краткий справочник по основному функционалу программы, так и полное учебное пособие. Методика изложения материала в данном случае будет зависеть от объема самой программы и требований заказчика. Чем подробнее будут описаны действия с системой, тем меньше вопросов возникнет у пользователя. Для более легкого понимания всех принципов работы с программой стандартами в документе Руководство пользователя допускается использовать схемы, таблицы, иллюстрации с изображением экранных форм. Для крупных автоматизированных систем рекомендуется создавать отдельное руководство для каждой категории пользователя (пользователь, модератор и т.п.). Если в работе с системой выделяются дополнительные роли пользователей, то в документе Руководство пользователя целесообразно поместить таблицу распределения функций между ролями. ### Аварийные ситуации Данный раздел документа Руководство пользователя должен содержать пошаговые инструкции действий пользователя в случае отказа работы Системы. Если к пользователю не были предъявлены особые требования по администрированию операционной системы и т.п., то можно ограничиться фразой «При отказе или сбое в работе Системы необходимо обратиться к Системному администратору».