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

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

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

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

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

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

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

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

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

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.

Данный документ формируется 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. Рекомендации по освоению

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

ПРИНЯТО на заседании общего собрания трудового коллектива Протокол №___ от «___» _________ 20___ г.

СОГЛАСОВАНО на заседании профкома Протокол № ___ от «___» _________ 20___ г. ________ Т.Ю. Моржина

УТВЕРЖДАЮ Директор Средней школы № 66 ________ Н.А. Софронова «___» _________ 20___ г.

ИНСТРУКЦИЯ

Пользователя информационной системы «Сетевой город.
Образование»

1. Общие положения

1.1. Инструкция пользователя информационной
системы «Сетевой город. Образование» (далее – ИС «Сетевой город. Образование») (далее
– Инструкция) определяет функциональные обязанности, права и ответственность
пользователей ИС «Сетевой город. Образование», в которой обрабатываются
персональные данные (далее – ПДн).

1.2. Настоящая Инструкция подготовлена в
соответствии с требованиями нормативно-методических документов ФСТЭК России и
ФСБ России по защите персональных данных, обрабатываемых с использованием
средств автоматизации.

1.3. В настоящей Инструкции используются
следующие понятия и определения:

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

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

3)      информация – сведения (сообщения, данные) независимо от формы их
представления;

4)      персональные данные – любая информация, относящаяся к прямо или
косвенно определённому, или определяемому физическому лицу (субъекту
персональных данных);

5)      информационная система персональных данных (ИСПДн) – совокупность
содержащихся в базах данных персональных данных и обеспечивающих их обработку
информационных технологий и технических средств;

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

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

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

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

10)  распространение
персональных данных – действия, направленные на раскрытие персональных данных определённому
лицу или неопределённому кругу лиц;

11)  разглашение
персональных данных – распространение персональных данных без согласия субъекта
персональных данных или наличия иного законного основания;

12)  средство
защиты информации (СЗИ) – программные, программно-аппаратные, аппаратные
средства, предназначенные и используемые для защиты персональных данных в ИС «Сетевой
город. Образование»;

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

14)  электронная
вычислительная машина ИС «Сетевой город. Образование» (ЭВМ) – персональный
компьютер, предназначенный для автоматизации деятельности пользователей и
входящий в состав ИС «Сетевой город. Образование». В состав ЭВМ входят:
системный блок, монитор, клавиатура, мышь, внешние устройства (локальный
принтер, сканер и т.д.), программное обеспечение.

 

2. Обязанности пользователя

2.1. Пользователь ИС «Сетевой город.
Образование» обязан:

2.1.1. Хранить в тайне ПДн, ставшие ему
известными во время работы или иным путём и пресекать действия других лиц,
которые могут привести к разглашению такой информации. О таких фактах, а также
о других причинах или условиях возможной утечки ПДн немедленно информировать
Ответственного за организацию обработки персональных данных, Администратора ИС
«Сетевой город. Образование» или Администратора ИБ.

2.1.2. При определении ПДн, подлежащих защите,
использовать «Перечень персональных данных, обрабатываемых в Средней школе №
66».

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

2.1.4. Хранить в тайне свой пароль доступа в ИС
«Сетевой город. Образование», а также информацию о системе защиты,
установленной в ИС «Сетевой город. Образование».

2.1.5. Использовать для работы, только учтённые
съёмные накопители информации (гибкие магнитные диски, компакт-диски и т.д.).

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

2.1.7. Немедленно ставить в известность
Администратора ИС «Сетевой город. Образование» и (или) Администратора ИБ ИС «Сетевой
город. Образование»:

1)     
в случае утери носителя с конфиденциальной
информацией (персональными данными) и (или) при подозрении компрометации личных
ключей и паролей;

2)     
нарушений целостности пломб (наклеек с защитной и
идентификационной информацией, нарушении или несоответствии номеров печатей) на
аппаратных средствах АРМ или иных фактов совершения попыток
несанкционированного доступа к ИС «Сетевой город. Образование»;

3)     
несанкционированных (произведённых с нарушением
установленного порядка) изменений в конфигурации программных или аппаратных
средств ИС «Сетевой город. Образование».

2.1.8. В случае отклонений в нормальной работе
системных и прикладных программных средств, затрудняющих эксплуатацию АРМ,
выхода из строя или неустойчивого функционирования узлов АРМ или периферийных
устройств (дисководов, принтера и т.п.), а также перебоев в системе
электроснабжения, некорректного функционирования установленных в ИС «Сетевой
город. Образование» технических средств защиты ставить в известность
Администратора ИС «Сетевой город. Образование» и (или) Администратора ИБ.

2.1.9. В случае увольнения пользователь ИС «Сетевой
город. Образование» обязан вернуть все документы и материалы, относящиеся к ИС
«Сетевой город. Образование». В том числе: отчёты, инструкции, служебную
переписку, списки работников, компьютерные программы, а также все прочие
материалы и копии названных материалов, имеющих какое-либо отношение к ИС «Сетевой
город. Образование», полученные в течение срока работы.

2.1.10. Уборка
помещений должна производиться под контролем пользователя ИС «Сетевой город.
Образование», имеющего доступ в помещение и постоянно в нем работающего.

2.1.11. Вынос
технических средств ИС «Сетевой город. Образование», на которой проводилась
обработка персональных данных, за пределы контролируемой зоны с целью их
ремонта, замены и т.п. без согласования с Администратором ИС «Сетевой город.
Образование» или Ответственным за организацию обработку ПДн запрещён. При
принятии решения о выносе компьютеров, жёсткие магнитные диски должны быть
демонтированы. В случае действия гарантийных обязательств фирмы-поставщика
вскрытие корпуса и демонтаж носителей должны быть предварительно согласованы с
ней.

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

2.2. Пользователю категорически запрещается:

1)  
передавать, устно или письменно, или иным способом ПДн
лицам, не допущенным к работе с этими ПДн;

2)  
использовать ПДн при подготовке открытых
публикаций, докладов, научных работ и т.д.;

3)  
выполнять работы с документами, содержащими ПДн, на
дому, выносить их из служебных помещений, снимать копии или производить выписки
из таких документов без разрешения Ответственного за организацию обработки
персональных данных;

4)  
оставлять на рабочих столах, в столах и незакрытых
сейфах документы, содержащие ПДн, а также оставлять незапертыми и не
опечатанными после окончания работы сейфы, помещения и хранилища с документами,
содержащими ПДн;

5)  
использовать компоненты программного и аппаратного
обеспечения ИС «Сетевой город. Образование» в неслужебных целях;

6)  
самовольно вносить какие-либо изменения в
конфигурацию аппаратно-программных средств АРМ или устанавливать дополнительно
любые программные и аппаратные средства;

7)  
осуществлять обработку ПДн в присутствии
посторонних (не допущенных к данной информации) лиц;

  
записывать и хранить ПДн на неучтённых носителях
информации (гибких магнитных дисках и т.п.);

9)  
оставлять включённой без присмотра своё АРМ, не
активизировав средства защиты информации от НСД (временную блокировку экрана и
клавиатуры);

10)            
умышленно использовать недокументированные свойства
и ошибки в программном обеспечении или в настройках средств защиты, которые
могут привести к возникновению кризисной ситуации. Об обнаружении такого рода
ошибок – ставить в известность Администратора ИС «Сетевой город. Образование»
или Администратора ИБ.

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

2.4. Оперативно докладывать Администратору ИС
«Сетевой город. Образование» и Администратору ИБ о случаях возникновения
нештатных ситуаций и аварийных ситуаций.

2.5. В кратчайшие сроки принимать меры по
восстановлению работоспособности элементов ИС «Сетевой город. Образование».

2.6. Предпринимаемые меры по возможности
согласуются с вышестоящим руководством.

3. Права пользователя

3.1. Пользователь имеет право:

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

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

 

4. Ответственность пользователя

 

4.1. Пользователь несёт ответственность за
соблюдение требований настоящей инструкции, а также нормативных документов в
области защиты информации.

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