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

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

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

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

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

Содержание

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

· Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение

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

· Страницу содержания

· Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы

· Главу, описывающую возможные проблемы и пути их решения

· Часто задаваемые вопросы и ответы на них

· Где ещё найти информацию по предмету, контактная информация

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

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

Стандарты

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

· Комплекс стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)

· РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ

· Единая система конструкторской документации (ЕСКД) определяет документ «Руководство по эксплуатации» и другие документы:

· ГОСТ 2.601-2013 Эксплуатационные документы

· ГОСТ 2.610-2006 Правила выполнения эксплуатационных документов

· Единая система программной документации (ЕСПД) определяет документы «Руководство оператора», «Руководство по техническому обслуживанию» и их структуру:

· ГОСТ 19.101-77 Виды программ и программных документов

· ГОСТ 19.105-78 Общие требования к программным документам

· ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению

· ГОСТ 19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

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

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

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

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

 

РД 50-34.698-90 (п.п. 3.4 Руководство пользователя)	ГОСТ 19.505-79 Руководство оператора
Введение
Область применения
Описание возможностей
Уровень подготовки пользователя
Перечень эксплуатационной документации, с которыми необходимо ознакомиться пользователю
Назначение и условия применения
Виды деятельности и функции, для автоматизации которых предназначена программа	Назначение программы
Условия, при которых обеспечивается применение программы	Условия выполнения программы
Подготовка к работе	Выполнение программы
Состав и содержание дистрибутивного носителя данных
Порядок загрузки данных и программ	Порядок загрузки, запуска и завершения программы
Проверка работоспособности
Описание операций	Описание функций
Описание всех выполняемых функций, задач, комплексов задач, процедур
Описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур
Аварийные ситуации(действия в случае длительных отказов технических средств, обнаружении несанкционированного вмешательства в данные, действия по восстановлению программ или данных, и т.п.)	Сообщения оператору
Рекомендации по освоению

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

ü Назначение системы;

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

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

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

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

Назначение системы

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

Пример:

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

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

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

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

Требования к аппаратному обеспечению – сюда можно включить требования к конфигурации компьютера пользователя, программное обеспечение необходимое для работы Системы, а также наличие дополнительного оборудования (принтер, сканер и т.п.), если таковое необходимо;

Квалификация пользователя – данный подраздел должен содержать требования к навыкам и знаниям пользователя (пример: «Пользователи должны обладать навыками работы с операционной системой Windows XP»);