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

Руководство пользователя – это основной документ в составе эксплуатационной документации на автоматизированную систему (ГОСТ 34). Очевидно ли это?

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

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

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

Конкретный подход к написанию определяется многими факторами:

– назначением программы и областью ее применения;

– сложностью программы;

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

Принимая во внимание все различия и особенности, сложно привести структуру любого Руководства пользователя к одному виду. Тем не менее, РД 50-34.698 предлагает нам такой список разделов:

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

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

– Подготовка к работе, где описывают комплектность дистрибутива, порядок установки и загрузки программы, а также способ проверки ее работоспособности;

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

– Аварийные ситуации, где описывают действия в нештатных ситуациях – сбоях в программе, ошибок в данных и т.д.;

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

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

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

Наличие Руководства пользователя регламентируется ГОСТ 34.201, а структура и содержание – РД 50-34.698. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства пользователя могут отличаться друг от друга по способу, методике и стилю изложения.

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

Наименование документа	Наименование стандарта	Стоимость разработки
РП на автоматизированную систему	РД 50-34.698	от 70 тыс. р.

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

Возможно, вас также заинтересует:

– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства оператора.

---

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

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

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

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

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

1. Введение.
2. Назначение и условия применения.
3. Подготовка к работе.
4. Описание операций.
5. Аварийные ситуации.
6. Рекомендации по освоению.

1. Введение

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

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

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

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

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

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

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

1. состав и содержание дистрибутивного носителя данных;
2. порядок загрузки данных и программ;
3. порядок проверки работоспособности.

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

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

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

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

1. наименование;
2. условия, при соблюдении которых возможно выполнение операции;
3. подготовительные действия;
4. основные действия в требуемой последовательности;
5. заключительные действия;
6. ресурсы, расходуемые на операцию.

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

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

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

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

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

Как с помощью руководства пользователя повысить качество информационной системы

В действительности все совершенно иначе, чем на самом деле.
Антуан де Сент-Экзюпери

Многое в разработке руководства пользователя регламентировано и описано ГОСТами. Но при создании больших гетерогенных систем могут возникать вопросы, не до конца освещенные этими документами.

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

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

Описание проблемы

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

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

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

2. Параллельная разработка.
Из-за масштаба системы над ней работают изолированные команды аналитиков, разработчиков и тестировщиков.

3. Частые изменения.
Опять же следствие масштаба — постоянный поток изменений и доработок.

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

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

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

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

Нужно было срочно исправлять ситуацию. Причем сделать это с минимальными затратами.

Поиск решения

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

Неактуальность документа

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

1. Составить описание модели «AS IS» (т.е. что у нас есть сейчас, какие функции и бизнес-процессы описаны).
2. Описать модель «TO BE» (в качестве консультантов привлекались ведущие аналитики по каждой подсистеме).
3. Сравнить «AS IS» и «TO BE» с помощью индикатора «Светофор» и составить план действий.

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

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

Далее наглядным индикатором «Светофор» были отмечены результаты сравнения:

1. Зеленый цвет – процесс есть в руководстве и нужен в бизнесе.
2. Красный – процесс есть, но не нужен (удалить!).
3. Желтый – процесс отсутствует, но нужен (добавить!).
4. Серый – процесс отсутствует и не нужен.

Использование цветовых индикаторов позволило выявить общую картину: руководство пользователя нужно править… и существенно.

Рисунок 1

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

Общее количество описаний функций в руководстве пользователя – более сотни, типовых – 25.
Дальнейшая обработка описаний потребовала дополнительной градации: ярко-зелёный  —  для сценариев, в которых всё хорошо и правки не требуются; светло-зеленый – для сценариев, которые в целом описаны правильно и нуждаются только в исправлении некоторых моментов; оранжевый – для тех, которые принципиально неправильно описаны и которые необходимо править в первую очередь.

Рисунок 2

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

Таблица соответствия в ходе работы над документом:

Рисунок 3

По завершении «покрасочных» работ обозначились приоритеты:

1. убрать оранжевый цвет – все должно быть описано корректно;
2. cделать светло-зеленые поля ярко-зелеными.

На этом моменте важно вспомнить про закон Парето (принцип 20/80): мы относительно быстро исправили наиболее проблемные оранжевые области и долго работали над светло-зелеными. Ведь в них, собственно, вся суть, если мы стремимся к тому, чтобы пользователь действительно мог работать с руководством.

Отсутствие единообразия

При решении этой проблемы ставилась задача обеспечить единообразие при описании сходных процессов (кейсов) и существенно сократить трудозатраты на обновление и поддержание документа. Был выбран подход, в соответствии с которым описание каждого процесса представляется в виде строительного блока (1), а сам документ – их комбинации (3). Все строительные блоки должны располагаться в репозитории (Wiki) с обязательным контролем изменений и поддержкой версионности (2).

Рисунок 4

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

Принципиально важный момент: доступ к репозиторию должен быть обеспечен всем командам, работающим над проектом, согласно сформированному регламенту его использования.
Используя такой подход для актуализации и метод «строительных блоков» для сборки, документ удалось за короткий срок привести в надлежащее состояние. Трудозатраты сократились более чем на 30%, по сравнению с традиционным методом формирования документа. Казалось бы, на этом месте можно было бы обозначить happy end, но мне бы хотелось продолжить. Будет интересно.

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

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

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

Рисунок 5

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

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

Рисунок 6

Выводы

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

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

Использование описанных подходов при формировании руководства пользователя позволяет:

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

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

---

P.S. В статью не вошли вопросы содержательности элементов и разделов руководства пользователя. Подробно это рассмотрено и регламентировано подразделом 3.4 документа РД 50-34.698-9 и стандартом IEEE 1063-2001.

Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

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

Руководство
пользователя как программная
(эксплуатационная) документация
пользователя

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

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

Документация:
программная/эксплуатационная/документация
пользователя

Предмет:
программа,
программный компонент комплекса
или системы

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

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

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

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

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

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

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

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

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

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

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

Пример:

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

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

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

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

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

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

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

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

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

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

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

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

Пример:

«4.1
Согласование проекта

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

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

4.1.1
 Создание проекта

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

• Наименование
  проекта;

• Описание
  проекта;

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

• Дата
  создания проекта – текущая дата;

• Автор
  – ФИО и должность автора проекта.»

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

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

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

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

Методика
и стиль изложения руководства пользователей

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

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

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

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

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

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

Соседние файлы в папке Лекции_МПО_ч2

• #
• #
• #
• #
• #
• #