Руководство оператора – это основной документ в составе эксплуатационной документации на программное обеспечение (ГОСТ 19). Очевидно ли это?
Назначение руководства оператора
В соответствии с государственными стандартами, Руководство оператора входит в состав комплекта эксплуатационной документации на программное обеспечение. Для чего нужен такой документ? Чтобы ответить на этот вопрос, необходимо понять, какую роль в использовании системы играет оператор.
Мы знаем, что администратор отвечает за настройку системы и поддержку работы пользователей. Пользователь же, в свою очередь, выполняет с помощью системы определенные прикладные функции, решает прикладные задачи. Роль оператора по своим функциям ближе всего к роли пользователя, однако, отличается от нее тем, что перед оператором не ставятся прикладные задачи, которые он может решить с помощью программы тем или иным способом, в том или ином порядке. Его работа заключается в выполнении отдельных операций (согласно инструкции), то есть конкретных последовательностей действий, приводящих к конкретному результату (например, ежедневный запуск вспомогательных программ).
Состав типового руководства оператора
Так, например, требования к содержанию и оформлению Руководства оператора представлены в ГОСТ 19.505. В соответствии с требованиями стандарта, документ должен содержать следующие разделы:
– Назначение программы, где указывают область применения ПО и общие сведения о ней.
– Условия выполнения программы, где должны быть указаны условия, необходимые для работы ПО.
– Выполнение программы, где описывают последовательность действий оператора, обеспечивающих выполнение его обязанностей, а также ожидаемые реакции программы на эти действия.
– Сообщения оператору, где приводят тексты сообщений, выдаваемых в ходе выполнения программы, а также действия оператора в случае, если реакция программы не соответствует ожидаемой.
Такая структура документа обычно позволяет сделать его удобным, понятным и отвечающим тем задачам, которые необходимо решить с его помощью. Однако, кроме официальных требований, на основании практического опыта можно сформулировать несколько принципов создания Руководства оператора:
– не стоит включать в документ теоретические описания и отступления, лучше собрать всю теорию в отдельный раздел, а лучше, по возможности, обойтись без нее совсем;
– лучше не ссылаться в документе на какие-либо внешние или внутренние источники, информацию предпочтительнее продублировать в том месте, где она необходима;
– описывать нужно не только действия оператора, но и те результаты, которые он должен получить.
Стандарты для руководства оператора
Наличие Руководства оператора регламентируется ГОСТ 19.101, а структура и содержание – ГОСТ 19.505. Однако, в зависимости от сложности, назначения и области применения ПО, различные Руководства оператора могут отличаться друг от друга по способу, методике и стилю изложения.
Заключение
В заключение хочется сказать, что, несмотря на все принципы и правила, у каждой системы всегда существуют особенности эксплуатации, которые нужно учесть в документации. Обратитесь к нам, и мы поможем вам преодолеть эти трудности и сэкономим ваше время!
– разработка руководства администратора;
– создание руководства программиста;
– разработка руководства пользователя.
Разработка
руководства по работе с программой
является одним из этапов создания
программного обеспечения. Оно должно
содержать подробные инструкции по
работе с программой, а также экранные
формы, иллюстрирующие текст.
Руководство
пользователя должно быть организовано
таким образом, чтобы любому человеку,
не знакомому со средой программирования,
программой и реализуемым ею методом,
были понятны действия, которые от него
требуется выполнить.
Примерный
план написания руководства пользователя
в соответствии с ГОСТ 19.505-79 «Руководство
оператора» /2/:
1.
Действия при запуске программы (какой
файл должен быть запущен, какие действия
должны при этом выполняться).
2.
Структура программы (какие окна есть,
как между ними переключаться, структура
меню и назначение его элементов).
3.
Каким образом осуществляется ввод
данных.
4.
Какая информация выводится на экран.
Таким
образом, нужно рассмотреть последовательность
всех операций по работе с программой
на конкретном примере, делая подробные
комментарии и иллюстрируя текст
графически.
При
необходимости можно указать: требуются
ли от пользователя какие-либо настройки,
если да, то какие; нужно ли использовать
дополнительное программное обеспечение
и т.п.
5. Оформление пояснительной записки
Оформление
пояснительной записки к курсовой работе
выполняется в соответствии правилами,
принятыми кафедрой «Программное
обеспечение» /3/.
В
список использованных источников
включаются только те источники, которые
использовались при подготовке курсовой
работы и на которые имеются ссылки в
работе.
При
описании литературного источника
необходимо указать /4,5/:
-
фамилии
и инициалы авторов, -
название
книги или статьи, -
место
издания, -
издательство,
-
год
издания.
При
описании ссылки на сайт Интернета
указать:
-
адрес
сайта, -
наименование
сайта.
В
приложениях
помещают вспомогательные или дополнительные
материалы, которые иллюстрируют текст
основной части работы ( таблицы, графики,
диаграммы, схемы, рисунки). В приложение
выносятся тексты программ и руководство
пользователя. Каждое приложение должно
начинаться с новой страницы с указанием
в правом верхнем углу слова «ПРИЛОЖЕНИЕ»
и иметь тематический заголовок. При
наличии в работе более одного приложения
они нумеруются арабскими цифрами. На
все представленные приложения должны
быть сделаны ссылки из текста.
6. Защита курсовой работы
На
защиту представляется пояснительная
записка с подписями студента и
руководителя, файлы программы.
По
результатам защиты курсовых работ
выставляется зачет с дифференцированной
оценкой по четырехбальной системе
(«отлично», «хорошо», «удовлетворительно»,
«неудовлетворительно»)
В
ходе защиты курсовой работы оцениваются:
-
правильность
и работоспособность программы, полнота
ее функциональных возможностей,
интерфейс пользователя; -
знание
среды программирования и основ
алгоритмизации, степень владения
материалом; -
аккуратность
оформления пояснительной записки; -
соответствие
материалов работы требованиям ГОСТ и
правилам, установленным кафедрой; -
понимание
использованных математических методов; -
изложение
материалов в устном докладе.
Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #
- #
Журавлев Денис
Когда и у кого возникает необходимость создания руководства пользователя по ГОСТ
Многие IT-компании, которые занимаются разработкой и сопровождением программного обеспечения и автоматизированных комплексов, сталкиваются с задачей создания пользовательской документации или руководств для своих продуктов в соответствии с требованиями ГОСТ.
Как правило, необходимость в наличии пользовательского руководства, составленного по ГОСТ, возникает при сотрудничестве с государственными организациями, крупными производствами и компаниями, при заказной разработке программного обеспечения по тендерам и госзаказам или при необходимости добавить программный продукт в «Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО)».
Какие ГОСТ используются при написании руководства пользователя приложения
Существует две серии (набора) стандартов, которые регламентируют набор создаваемых документов и правила их оформления при разработке автоматизированных систем, комплексов и программного обеспечения:
- ГОСТ 34 — Автоматизированные системы
- ГОСТ 19 — Единая система программной документации (ЕСПД)
С одной стороны, эти два стандарта конкурируют между собой, предлагаю различные варианты комплектности документации на проект. С другой стороны, они фокусируются на разных аспектах, и поэтому хорошо дополняют друг друга.
ГОСТ 34 главным образом определяет комплектность, виды, структуру и содержание создаваемых документов.
ГОСТ 19 в большей степени определяет правила оформления документов.
Поэтому, на практике часто используются сразу оба этих ГОСТа.
Руководство пользователя — основной документ для конечного пользователя
Если говорить именно о документации для конечного пользователя системы, то из перечня описываемых в ГОСТ 34 документов нас интересует «Руководство пользователя». В ГОСТ 19 аналогичный по смыслу документ называется «Руководство оператора», но для программного обеспечения чаще используется именно первый вариант.
Руководство пользователя поставляется с любым изделием, программой, системой. Он должен предоставлять пользователю информацию о свойствах продукта, его функциональности, способах использования и работе с ним.
Сложности написания руководства пользователя по ГОСТ
Для начинающего технического писателя или простого специалиста, которому неожиданно поручили написать руководство пользователя по ГОСТ, эта задача является серьезной проблемой.
Мало того, что необходимо изучить большое число нормативных документов, изобилующих перекрестными ссылками и написанных сложным, излишне канцелярским, почти юридическим языком, так еще необходимо выбрать оттуда требования, относящиеся именно к создаваемому виду документа. Затем, на протяжении всей работы, нужно постоянно контролировать соблюдение этих требований в рабочем документе, постоянно сверяясь со стандартами.
Обычно проблема усугубляется еще и нехваткой времени, так как писать пользовательскую документацию, к сожалению, часто принято в самом конце проекта, перед самым дедлайном — датой сдачи или запуска системы.
У опытного технического писателя документирование по ГОСТ, возможно, не вызовет серьезных затруднений. Однако, даже у него подготовка шаблонов новых документов, приведение к требованиями стандартов существующей документации или проверка финального документа на соответствие этим требованиям может занять существенное время.
Dr.Explain упрощает создание руководства пользователя по ГОСТ
Начиная с версии 5.5.1100 программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах. Эта функция призвана значительно облегчить жизнь пользователям, перед которыми стоит задача создания руководства пользователя в соответствии с требованиями государственных стандартов.
В частности программа Dr.Explain контролирует и автоматизирует поддержку следующих требований стандартов:
- Наличие обязательных разделов документа “Руководство пользователя” [ГОСТ 34 РД 50-34.698-90]. Все разделы снабжаются пояснениями по их содержанию.
- Оформление титульных листов, аннотации и содержания [ГОСТ 19.105-78, 19.104-78].
- Параметры печатных страниц документа и расположение основных элементов на них [ГОСТ 19.106-78].
- Структуру и оформление колонтитулов [ГОСТ 19.106-78].
- Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы [ГОСТ 19.106-78].
- Формирование и оформление заголовков, разделов, перечислений (списков) [ГОСТ 19.106-78].
Управление функцией поддержки ГОСТ для проекта доступно в Настройках проекта в разделе Общие.
При включенном режиме поддержки ГОСТ для проекта соответствующие пользовательские настройки для печатаемых форматов RTF\DOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.
Для выходных форматов HTML и CHM будут использоваться пользовательские настройки вне зависимости от активности режима поддержки ГОСТ. Это снимает ограничение на свободную стилизацию этих форматов и позволяет, например, оформить онлайн-справку полностью в корпоративном или тематическом стиле.
Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.
Важно: Функция поддержки ГОСТ доступна в Dr.Explain только в русскоязычной версии интерфейса. Язык интерфейса программы выбирается в меню Настройки\Выбор языка программы (Options\Application language).
Создание нового руководства пользователя по ГОСТ
Для создания нового руководства пользователя по требованиям ГОСТ 34 в программе Dr.Explain можно использовать команды меню Файл \ Создать локальный проект — Руководство пользователя по ГОСТ 34 или Файл \ Создать общий проект на tiwri.com — Руководство пользователя по ГОСТ 34
или аналогичные кнопки на стартовом экране приложения.
Программа создаст новый проект, в котором уже присутствуют шаблон титульного листа, аннотация, оглавление и обязательные разделы, оформленные по ГОСТ.
В тексте каждого раздела будет приведена краткая инструкция-подсказка о том, что необходимо включить в данный раздел. Пользователю необходимо только наполнить разделы актуальным содержимым.
Настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.
Приведение существующей пользовательской документации в соответствие с требованиями ГОСТ
Также программа Dr.Explain позволяет привести существующую пользовательскую документацию в соответствии с требованиями ГОСТ.
Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.
Если исходная документация еще не ведется в Dr.Explain, а хранится в других форматах, первым шагом необходимо выполнить импорт существующих документов в программу. Dr.Explain поддерживает импорт документов из ряда популярных форматов. Команды импорта доступны как на стартовом окне программы, так и в меню Файл.
Затем необходимо включить режим поддержки ГОСТ в свойствах проекта описанным ранее способом.
Программа проверит структуру документа на наличие обязательных разделов и, если они отсутствуют, создаст их. Остальные существующие разделы, наличие которых не регламентировано ГОСТами, будут перенесены в скрытый от экспорта раздел “Старое дерево разделов”.
Пользователь должен будет перенести содержимое этих разделов или разделы целиком методом drag-n-drop в основное дерево проекта и отредактировать их по необходимости.
Как и в первом случае настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.
Создайте документацию, соответсвующую ГОСТ 19 и ГОСТ 34 в Dr.Explain бесплатно
Смотрите также
- Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации
petr2off писал(а): ↑27 июн 2018, 06:39
Я сделал документ по ГОСТ 19.505-79. Руководство оператора. И основная претензия была — нафиг оператору знать про диски и базы данные всякие. Описание программы совсем не нужно знать оператору. Ему нужно видеть, что все в порядке, а если не в порядке — то должно быть сообщение куда бежать и кому звонить.
Всё правильно. В первой же главе этого ГОСТа читаем:
Руководство оператора должно содержать разделы:
- назначение
- условия выполнения
- выполнение
- сообщения оператору
Где тут устройство аппаратной части, перечень неисправностей и способы их устранения? Претензия обоснована. Это ведь ЕСПД.
А автор к ЕСКД обращается, то есть у него железо, не софт. Как бы совсем разные вещи.
petr2off писал(а): ↑26 июн 2018, 11:35
Но заказчик выразил неудовольствие, но — общегнесеологическое, т.е. без ссылок на регламентирующий документ, который его бы удовлетворил. Начальник тот тоже тяготеет к общечеловеческим термином. По его мнению — «Оператор — это законченный дебил, а поэтому надо вот ,… что бы понятно было.
Тоже логично.
Ну, нам ведь не видно как там у Вас написано. А в общем, раздел «использование по назначению» должен содержать список операций, штатно выполняемых оператором/персоналом, и каждый пункт должен содержать пошаговую инструкцию типа «нажми сюда — узри это». Горячо любимое ранее советскими разработчиками описание принципов работы схемы сюда включать НЕ НАДО.
- [+] пример того, что не надо упоминать в руководстве оператора
Если очень хочется это описать — опишите в другом отдельном разделе руководства по эксплуатации.
Не знаю деталей, но заказчик в одном абсолютно прав: руководство оператора должно быть написано так, чтобы его инструкции смог выполнить человек любого уровня интеллекта, оказавшийся рядом с этой установкой. Примерно как в кино стюардессы или случайные пассажиры сажают самолёты вручную по голосовым командам диспетчера с земли (причём диспетчер тоже не особо в курсе, как управлять таким самолётом).
Отправлено спустя 5 минут 52 секунды:
Руководство — это руководящий документ, а не обучающий и не описательный. Термины следует понимать буквально.
Практическая работа №13
Тема: Руководство пользователя.
Цель работы: Ознакомиться с видами руководства
пользователя, изучить нормативно правовую документацию, регламентирующую
разработку руководств пользователя, приобрести навыки разработки руководства
пользователя программного средства.
Теоретические
сведения.
Руководство
пользователя (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 «Руководство оператора. Требования к содержанию и оформлению». Ниже для
сравнения приведены структуры документа согласно двум перечисленным стандартам.
РД |
ГОСТ 19.505-79 Руководство оператора |
Введение |
|
Область |
|
Описание |
|
Уровень |
|
Перечень |
|
Назначение |
|
Виды |
Назначение |
Условия, |
Условия |
Подготовка |
Выполнение |
Состав |
|
Порядок |
Порядок |
Проверка |
|
Описание |
Описание |
Описание |
|
Описание |
|
Аварийные |
Сообщения |
Рекомендации |
Таким образом, мы можем выделить следующие основные разделы руководства
пользователя:
ü Назначение
системы;
ü Условия применения
системы;
ü Подготовка системы
к работе;
ü Описание операций;
ü Аварийные
ситуации.
Назначение системы
Данный раздел
документа Руководство пользователя должен содержать информацию о назначении
системы, ее целях и задачах.
Пример:
«Корпоративный
интранет портал предназначен для повышения корпоративной культурыр организации
эффективного взаимодействия сотрудников.
Основной
целью Порта является создание единого информационного пространства предприятия
и оптимизация работы сотрудников путем облегчения коммуникаций между ними и
оптимизации ряда бизнес-процессов.»
Условия
применения системы
Данный
раздел документа Руководство пользователя должен включать все те факторы,
которые необходимы для корректной работы системы. Здесь можно выделить
несколько подразделов:
Требования
к аппаратному обеспечению – сюда можно включить требования к конфигурации
компьютера пользователя, программное обеспечение необходимое для работы
Системы, а также наличие дополнительного оборудования (принтер, сканер и т.п.),
если таковое необходимо;
Квалификация
пользователя – данный подраздел должен содержать требования к навыкам и знаниям
пользователя (пример: «Пользователи должны обладать навыками работы с
операционной системой Windows XP»);
Подготовка
системы к работе
Данный
раздел документа Руководство пользователя должен содержать пошаговую инструкцию
для запуска приложения. К этапу подготовки системы к работе можно отнести
установку дополнительных приложений (при необходимости), идентификацию,
аутентификацию и т.п.
Описание
операций
Это
основной раздел документа Руководство пользователя, который содержит пошаговую
инструкцию для выполнения того или иного действия пользователем.
Если
работа автоматизированной системы затрагивает целый бизнес-процесс, то в
руководстве пользователя перед описанием операций целесообразно предоставить
информацию о данном процессе его назначении и участниках. Подобное решение
позволяет человеку четко представить свою роль в данном процессе и те функции,
которые реализованы для него в системе.
Далее в
документе Руководство пользователя следует представить описание функций
разбитых на отдельные операции. Необходимо выделить подразделы, описывающие
функции данного процесса, и действия, которые необходимо совершить для их
выполнения.
Пример:
«4.1
Согласование проекта. Данный процесс предназначен для организации работы
сотрудников, участвующих в разработке и согласовании проекта.
Автор проекта создает запись в Системе и прикрепляет пакет необходимой
документации, далее проект передается на согласование руководящими лицами.
Руководители после ознакомления с проектом могут подтвердить его или отправить
на доработку Автору.
4.1.1
Создание проекта. Для того чтобы создать Проект необходимо на панели «…»
нажать на кнопку «…» и в появившейся форме заполнить следующие поля:
Наименование
проекта;
Описание
проекта;
Следующие
поля заполняются автоматически:
Дата
создания проекта – текущая дата;
Автор –
ИФО и должность автора проекта.»
Руководство
пользователя может представлять собой как краткий справочник по основному
функционалу программы, так и полное учебное пособие. Методика изложения
материала в данном случае будет зависеть от объема самой программы и требований
заказчика.
Чем
подробнее будут описаны действия с системой, тем меньше вопросов возникнет у
пользователя. Для более легкого понимания всех принципов работы с программой
стандартами в документе Руководство пользователя допускается использовать
схемы, таблицы, иллюстрации с изображением экранных форм.
Для
крупных автоматизированных систем рекомендуется создавать отдельное руководство
для каждой категории пользователя (пользователь, модератор и т.п.). Если в
работе с системой выделяются дополнительные роли пользователей, то в документе
Руководство пользователя целесообразно поместить таблицу распределения функций
между ролями.
Аварийные
ситуации
Данный
раздел документа Руководство пользователя должен содержать пошаговые инструкции
действий пользователя в случае отказа работы Системы. Если к пользователю не
были предъявлены особые требования по администрированию операционной системы и
т.п., то можно ограничиться фразой «При отказе или сбое в работе Системы
необходимо обратиться к Системному администратору».
Ниже представлен пример (образец)
документа «Руководство пользователя«, разработанного на
основании методических указаний РД
50-34.698-90.
Данный документ формируется
IT-специалистом, или функциональным специалистом, или техническим писателем в
ходе разработки рабочей документации на систему и её части на стадии «Рабочая
документация».
Для формирования руководства пользователя
в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической
системы «Корпоративное хранилище данных».
Ниже приведен состав руководства
пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к
содержанию и текст примера заполнения (выделен вертикальной
чертой).
Разделы руководства пользователя:
1.
Введение.
2.
Назначение и
условия применения.
3.
Подготовка к
работе.
4.
Описание операций.
5.
Аварийные
ситуации.
6.
Рекомендации по
освоению.
1. Введение
В разделе «Введение»
указывают:
1.
область применения;
2.
краткое
описание возможностей;
3.
уровень
подготовки пользователя;
4.
перечень
эксплуатационной документации, с которой необходимо ознакомиться пользователю.
1.1. Область применения
Требования настоящего документа
применяются при:
· предварительных комплексных
испытаниях;
· опытной эксплуатации;
· приемочных испытаниях;
· промышленной эксплуатации.
1.2. Краткое описание возможностей
Информационно-аналитическая
система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации
технологии принятия тактических и стратегических управленческих решений
конечными бизнес-пользователями на основе информации о всех аспектах
финансово-хозяйственной деятельности Компании.
ИАС КХД предоставляет возможность
работы с регламентированной и нерегламентированной отчетностью.
При работе с отчетностью
используется инструмент пользователя Oracle Discoverer Plus, который
предоставляет следующие возможности:
· формирование табличных и
кросс-табличных отчетов;
· построение различных диаграмм;
· экспорт и импорт результатов
анализа;
· печать результатов анализа;
· распространение результатов
анализа.
1.3. Уровень подготовки
пользователя
Пользователь ИАС КХД должен иметь
опыт работы с ОС MS Windows (95/98/NT/2000/XP), навык работы с ПО Internet
Explorer, Oracle Discoverer, а также обладать следующими знаниями:
· знать соответствующую предметную
область;
· знать основы многомерного анализа;
· понимать многомерную модель
соответствующей предметной области;
· знать и иметь навыки работы с
аналитическими приложениями.
Квалификация пользователя должна
позволять:
· формировать отчеты в Oracle
Discoverer Plus;
· осуществлять анализ данных.
1.4. Перечень эксплуатационной
документации, с которой необходимо ознакомиться пользователю
· Информационно-аналитическая
система «Корпоративное хранилище данных». ПАСПОРТ;
· Информационно-аналитическая
система «Корпоративное хранилище данных». ОБЩЕЕ ОПИСАНИЕ СИСТЕМЫ.
2. Назначение и условия применения
Oracle Discoverer Plus
В разделе «Назначение и
условия применения» указывают:
1.
виды
деятельности, функции, для автоматизации которых предназначено данное средство
автоматизации;
2.
условия, при
соблюдении (выполнении, наступлении) которых обеспечивается применение средства
автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация
технических средств, операционная среда и общесистемные программные средства,
входная информация, носители данных, база данных, требования к подготовке
специалистов и т. п.).
Oracle Discoverer Plus в составе
ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по
показателям деятельности, а также для углубленного исследования данных на
основе корпоративной информации хранилища данных.
Работа с Oracle Discoverer Plus в
составе ИАС КХД возможна всегда, когда есть необходимость в получении
информации для анализа, контроля, мониторинга и принятия решений на ее основе.
Работа с Oracle Discoverer Plus в
составе ИАС КХД доступна всем пользователям с установленными правами доступа.
3. Подготовка к работе
В разделе «Подготовка к работе»
указывают:
1.
состав и
содержание дистрибутивного носителя данных;
2.
порядок
загрузки данных и программ;
3.
порядок
проверки работоспособности.
3.1. Состав и содержание
дистрибутивного носителя данных
Для работы с ИАС КХД необходимо
следующее программное обеспечение:
1.
Internet
Explorer (входит в состав операционной системы Windows);
2.
Oracle
JInitiator устанавливается автоматически при первом обращении пользователя к
ИАС КХД.
3.2. Порядок загрузки данных и
программ
Перед началом работы с ИАС КХД на
рабочем месте пользователя необходимо выполнить следующие действия:
1.
Необходимо
зайти на сайт ИАС КХД ias-dwh.ru.
2.
Во время
загрузки в появившемся окне «Предупреждение о безопасности», которое
будет содержать следующее: ‘Хотите установить и выполнить «Oracle JInitiator»
…’ Нажимаем на кнопку «Да».
3.
После чего
запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next
и затем OK.
3.3. Порядок проверки
работоспособности
Для проверки доступности ИАС КХД с
рабочего места пользователя необходимо выполнить следующие действия:
1.
Открыть
Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer»
на рабочем столе или вызвать из меню «Пуск».
2.
Ввести в
адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход».
3.
В форме аутентификации
ввести пользовательский логин и пароль. Нажать кнопку «Далее».
4.
Убедиться, что
в окне открылось приложение Oracle Discoverer Plus.
В случае если приложение Oracle
Discoverer Plus не запускается, то следует обратиться в службу поддержки.
4. Описание операций
В разделе «Описание
операций» указывают:
1.
описание всех
выполняемых функций, задач, комплексов задач, процедур;
2.
описание
операций технологического процесса обработки данных, необходимых для выполнения
функций, комплексов задач (задач), процедур.
Для каждой операции обработки
данных указывают:
1.
наименование;
2.
условия, при
соблюдении которых возможно выполнение операции;
3.
подготовительные
действия;
4.
основные
действия в требуемой последовательности;
5.
заключительные
действия;
6.
ресурсы, расходуемые
на операцию.
В описании действий допускаются
ссылки на файлы подсказок, размещенные на магнитных носителях.
4.1. Выполняемые функции и задачи
Oracle Discoverer Plus в составе
ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:
Функции |
Задачи |
Описание |
Обеспечивает многомерный |
Визуализация отчетности |
В ходе выполнения данной |
Формирование табличных и |
В ходе выполнения данной |
4.2. Описание операций
технологического процесса обработки данных, необходимых для выполнения задач
Ниже приведено описание
пользовательских операций для выполнения каждой из задач.
Задача:
«Визуализация отчетности»
Операция 1: Регистрация на портале
ИАС КХД
Условия,
при соблюдении которых возможно выполнение операции:
1.
Компьютер
пользователя подключен к корпоративной сети.
2.
Портал ИАС КХД
доступен.
3.
ИАС КХД
функционирует в штатном режиме.
Подготовительные
действия:
На компьютере пользователя
необходимо выполнить дополнительные настройки, приведенные в п. 3.2 настоящего
документа.
Основные
действия в требуемой последовательности:
1.
На иконке «ИАС
КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки.
2.
В открывшемся
окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя.
Нажать кнопку «Далее».
Заключительные
действия:
Не требуются.
Ресурсы,
расходуемые на операцию:
15-30 секунд.
Операция 2: Выбор отчета
Условия,
при соблюдении которых возможно выполнение операции:
Успешная регистрация на Портале
ИАС КХД.
Подготовительные
действия:
Не требуются.
Основные
действия в требуемой последовательности:
1. В появившемся окне «Мастер
создания рабочих книг» поставить точку напротив пункта «Открыть существующую
рабочую книгу».
2. Выбрать нужную рабочую книгу и
нажать кнопку «Откр.»:
Заключительные действия:
После завершения работы с отчетом
необходимо выбрать пункт меню «Файл», далее выбрать пункт «Закрыть».
Ресурсы,
расходуемые на операцию:
15 секунд.
Задача:
«Формирование табличных и графических форм отчетности»
Заполняется по аналогии.
5. Аварийные ситуации
В разделе «Аварийные
ситуации» указывают: 1. действия в случае несоблюдения условий выполнения
технологического процесса, в том числе при длительных отказах технических
средств; 2. действия по восстановлению программ и/или данных при отказе
магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях
обнаружении несанкционированного вмешательства в данные; 4. действия в других
аварийных ситуациях.
В случае возникновения ошибок при
работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к
сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к
ответственному Администратору ИАС КХД.
Класс ошибки |
Ошибка |
Описание ошибки |
Требуемые |
Портал ИАС КХД |
Сервер не найден. |
Возможны проблемы с |
Для устранения проблем с |
Ошибка: Требуется ввести |
При регистрации на |
Ввести имя пользователя. |
|
Ошибка: Требуется ввести |
При регистрации на |
Ввести пароль. |
|
Ошибка: Сбой |
Неверно введено имя |
Нужно повторить ввод |
|
Сбой в электропитании |
Нет электропитания |
Рабочая станция |
Перезагрузить рабочую |
Сбой локальной сети |
Нет сетевого |
Отсутствует возможность |
Перезагрузить рабочую |
6. Рекомендации по освоению
В разделе «Рекомендации по
освоению» указывают рекомендации по освоению и эксплуатации, включая
описание контрольного примера, правила его запуска и выполнения.
Рекомендуемая литература:
· Oracle® Business Intelligence Discoverer
Viewer User’s Guide
· Oracle® Business Intelligence Discoverer
Plus User’s Guide
Рекомендуемые курсы обучения:
· Discoverer 10g: Создание запросов
и отчетов
В качестве контрольного примера
рекомендуется выполнить операции задачи «Визуализация отчетности», описанные в
п. 4.2. настоящего документа.
Ход
работы:
Задание 1.
Изучите
свой вариант руководства пользователя. Опишите его по следующему плану:
1) для
какого продукта, предназначено руководство пользователя (наименование, модель);
2)
основные технические характеристики продукта;
3)
основные разделы руководства пользователя (название раздела и краткое его
описание)
Задание 2.
Откройте
документ «Образец руководства пользователя», заполните в нем первые разделы для
своего вымышленного программного продукта.
Сделайте
вывод
о проделанной работе.
Контрольные
вопросы:
1) Дайте
определения понятиям «руководство пользователя», «инструкция по эксплуатации»
2) Какие
основные разделы должно содержать руководство пользователя?
3) Какие
стандарты описывают Руководство пользователя Руководство оператора, Руководство
программиста, Руководство системного программиста?
4) Что
описывает раздел «назначение системы»?
5) Что
указывается в разделе «условия применения системы»?
6) Какая
информация содержится в разделе «Описание операций»?