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