Меню

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

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

Узбекское Агентство
Связи и Информатизации

Ташкентский Университет Информационных Технологий

Кафедра
«Программное обеспечение информационных технологий»

Преподаватель дисциплины

Выдержки из лекций

Инструкция по использованию программного обеспечения

Инструкция по использованию программного обеспечения (или просто «Инструкция пользователю», или «Руководство для поль­зователя») — это выдержка из полной документации, предназ­наченная для эксплуатации программного обеспечения. Она представляет собой независимый документ, в котором описы­вается: что делает программное обеспечение и как им поль­зоваться.

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

Первая часть инструкции является описательной и должна содержать:

— наименование программного обеспечения;

— краткое описание программного обеспечения;

— перечень выполняемых им функций;

— краткую характеристику метода (или методов), его досто­инство и недостатки;

— полную библиографическую ссылку на полное описание метода;

— описание входных и выходных данных.

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

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

— как запустить программное обеспечение;

— как продолжить работу с программным обеспечением (описывается подробный интерактивный режим его работы с ПО);

— подготовка и ввод исходных данных в программное обес­печение;

— как реагировать на запросы программного обеспечения;

— как вести работу в исключительных ситуациях;

— как реагировать на ошибки;

— как восстановить работу программного обеспечения в случае аварийного его завершения;

— как получить требуемый результат;

— как правильно закончить работу с программным обес­печением (запланированный программой выход).

Источник

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

РП на автоматизированную систему

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

Источник

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

Екатерина Филатова, 12.06.2006

Vlad Golovach

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

Очевидны две базовые проблемы. Авторы руководств:

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

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

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

И с учетом этих представлений создавать текст руководства.

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

Структура руководства

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

Заглянув в такое руководство и потратив впустую некоторое время, пользователь вряд ли воспользуется им вновь. Поэтому очевидно, что:

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

Попробуем применить эти принципы к конкретному руководству. Проанализируем структуру руководства пользователя для работы с Автоматизированной информационно-аналитической системой «Библиотека». Его содержание:

  • Введение
  • Программа «Библиотека» позволяет Технические требования Установка программы Особенности работы с модулем «Рабочее место библиотекаря»
  • Описание программы
  • Введение Общая концепция данных в АИАС «Библиотека» С чего начать? Составление списка сотрудников и читателей Источники поступления Оформление поступления Акт поступления Распределение документов по подразделениям и формам индивидуального учета Книга суммарного учета Книга индивидуального учета Поиск и редактирование документов
  • Поиск Редактирование Замена Выбытие Выдача
  • Реестр актов Акт проверки фонда Акт замены Акт выбытия Тетрадь замены документов Словарь Справочник
  • Общие положения Поиск и редактирования Добавление нового описания Указание списка авторов Копирование записи Импорт данных Утилиты по работе с базой
  • План работы Абонемент Классы
  • Создание класса Работа с классами Выдача классам Выдача ученикам Выдача через таблицу Формирование таблицы
  • Статистика Печать Справка
Читайте также:  Форма выпуска упаковка и состав препарата Бальзам Золотая Звезда

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

  1. Целых три раздела: Программа «Библиотека» позволяет, Введение и Общая концепция данных в АИАС «Библиотека» по-разному описывают одно и то же — задачи и возможности программы Библиотека. Зачем дробить и удлинять структуру? Будет проще и логичнее объединить их один раздел.
  2. В разделе Особенности работы с модулем «Рабочее место библиотекаря» можно отметить целых две проблемы. Во-первых, из содержания непонятно, что это за модуль и откуда он взялся. Во-вторых, в разделе описывается не особенность работы с этим модулем, а процесс его установки. Получается, что автор сознательно запутывает пользователя и даже обманывает, заставляя самостоятельно разбираться в проблеме. Эту информацию следует перенести в раздел, описывающий процесс установки.
  3. Раздел Установка программы рассказывает, что данный программный продукт состоит из четырех отдельно устанавливаемых модулей. Как устанавливать эти модули неясно, и лишь информация об установке одного модуля выносится в отдельную главу. Логичнее рассказать пользователю о модулях в разделе, посвященном описанию самой программы, а в разделе Установка рассказать об особенностях установки.
  4. Заголовок Описание программы не совсем уместен, поскольку описание программы есть в начале руководства, далее необходимо рассказать пользователю о том, как собственно работать с этой программой. Получается, что заголовок дезинформирует пользователя. Это явная ошибка.
  5. Все три раздела С чего начать?, Составление списка сотрудников и читателей, Источники поступления повествуют о необходимых настройках программы перед началом работы, а именно: регистрации учреждения, формировании подразделений, форм учета и списка читателей, сотрудников и источников поступления. Эти действия необходимо совершить один раз и затем лишь вносить изменения. Поэтому совершенно непонятно, зачем автор руководства делит эту информацию на разные разделы.
  6. После завершения всех настроек пользователь может начинать работать. Соответственно в руководстве пользователя далее помещается информация, как работать с документами, абонементом и классами, а также вести учет.
  7. Раздел Справочник. Неверное название вводит пользователя в заблуждение. Из содержания неясно, что это и есть База шаблонов библиографических описаний, которая поставляется вместе с программным продуктом, о чем говорится в описании к программе. Пользователь должен знать, что ему не требуется вносить описания вручную, а только пользоваться шаблонами.
  8. Все Акты и Реестр Актов относятся к специальной базе данных учетных форм, списков, реестров, предусмотренной программным продуктом. Об этом также говорится в описании к программе, и логичнее объединить соответствующие главы в один раздел, посвященный работе по учету информации.
  9. Разделы Словарь и Справка вполне можно объединить в раздел Справочная информация или хотя бы перенести Словарь в конец руководства.
  10. И, наконец, не во всех разделах присутствует информация о том, чем этот раздел полезен пользователю, для чего, когда и как лучше его использовать. Это обстоятельство, вкупе с нечеткой структурой и расплывчатыми формулировками, сильно затруднит освоение программного продукта пользователем.

С учетом обозначенных замечаний получаем более простую и логичную структуру руководства:

  • Задачи и возможности программы «Библиотека»
  • Технические требования
  • Установка программы
  • Настройка программы
  • Работа с программой
  • Работа с документами
  • Оформление поступлений Поиск Редактирование Замена Выбытие Выдача Распределение документов по подразделениям и формам индивидуального учета
  • Учет документов
  • Реестр актов Акт поступления Акт проверки фонда Акт замены Акт выбытия Книга суммарного учета Книга индивидуального учета
  • База шаблонов библиографических описаний
  • Поиск и редактирования Добавление нового описания Указание списка авторов Копирование записи Импорт данных Утилиты по работе с базой
  • Планирование работы Абонемент Классы Статистика Печать
  • Справочная информация

Приведенное в качестве примера руководство вполне обычно. Инструкций подобного качества, к сожалению, множество. Собственно именно это и заставляет многих авторов и пользователей считать, что руководство пишется ради самого руководства («чтобы было»), и никто его не читает. Но эту ситуацию вполне можно изменить.

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

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

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

Краткость и стиль

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

Как применить эти принципы на практике рассмотрим на примерах с типичными ошибками.

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

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

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

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

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

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

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

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

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

Такой шаблонно-бюрократический текст не только непонятен, но и отпугивает пользователя. Руководство, написанное похожим языком, вряд ли когда-либо будут читать. Фраза Перед началом работы выполните следующие действия проще в разы.

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

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

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

Элементарные грамматические ошибки или обычные недочеты, как в данном случае — многократное повторение слова «было», не добавят доверия к руководству и его автору.

Читайте также:  Вентилятор CAMERON FCS4050 Где заказать запчасть

Выводы

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

  • Главная персона в руководстве всегда пользователь и его запросы при работе с данным продуктом. Руководство не должно обманывать его ожидания. Оно должно отвечать на вопросы, а не заставлять читать описания интерфейса программы.
  • Четкость характеристик. Пользователю необходимо ясно объяснить не только как совершить то или иное действие, но и как лучше это сделать, когда лучше, для чего и к чему это приведет. В этом случае пользователь лучше сможет ориентироваться в программном продукте и использовать его по максимуму. Расплывчатые и непонятные формулировки здесь неуместны!
  • Краткость текста. Текст должен быть небольшим и легко читаться. Нужно избегать тяжеловесных форм с многочисленными причастными или деепричастными оборотами, вводными словами и т.д. И нельзя заставлять пользователя читать лишние детали. Пользователь не должен тратить время на длинные и зачастую ненужные описания.
  • Стилистически и грамматически правильный текст. Грамотный текст облегчает восприятие текста и повышает доверие пользователя к руководству.

Источник



Корпоративные хранилища данных. Интеграция систем. Проектная документация.

РД 50-34.698-90 Руководство пользователя (пример оформления)

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

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

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

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

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

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. В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее».

Заключительные действия:

Ресурсы, расходуемые на операцию:

Операция 2: Выбор отчета

Условия, при соблюдении которых возможно выполнение операции:

Успешная регистрация на Портале ИАС КХД.

Подготовительные действия:

Основные действия в требуемой последовательности:

1. В появившемся окне «Мастер создания рабочих книг» поставить точку напротив пункта «Открыть существующую рабочую книгу».

2. Выбрать нужную рабочую книгу и нажать кнопку «Откр.»:

Заключительные действия:

После завершения работы с отчетом необходимо выбрать пункт меню «Файл», далее выбрать пункт «Закрыть».

Ресурсы, расходуемые на операцию:

Задача: «Формирование табличных и графических форм отчетности»

Заполняется по аналогии.

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

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

Читайте также:  Как настроить телевизор GoldStar Пульт для телевизора ГолдСтар

В случае возникновения ошибок при работе ИАС КХД, не описанных ниже в данном разделе, необходимо обращаться к сотруднику подразделения технической поддержки ДИТ (HelpDesk) либо к ответственному Администратору ИАС КХД.

Класс ошибки Ошибка Описание ошибки Требуемые действия пользователя при возникновении ошибки
Портал ИАС КХД Сервер не найден. Невозможно отобразить страницу Возможны проблемы с сетью или с доступом к порталу ИАС КХД. Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (HelpDesk). В других случаях к администратору ИАС КХД.
Ошибка: Требуется ввести действительное имя пользователя При регистрации на портале ИАС КХД не введено имя пользователя. Ввести имя пользователя.
Ошибка: Требуется ввести пароль для регистрации При регистрации на портале ИАС КХД не введен пароль. Ввести пароль.
Ошибка: Сбой аутентификации. Повторите попытку Неверно введено имя пользователя или пароль, либо такая учетная запись не зарегистрирована. Нужно повторить ввод имени пользователя и пароля, однако после третей неудачной попытки регистрации учетная запись блокируется. Если учетная запись заблокирована, нужно обратиться к администратору ИАС КХД.
Сбой в электропитании рабочей станции Нет электропитания рабочей станции или произошел сбой в электропитании. Рабочая станция выключилась или перезагрузилась. Перезагрузить рабочую станцию.
Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды:
— нажать кнопку «Пуск»
— выбрать пункт «Выполнить»
— в строке ввода набрать команду telnet ias_dwh.ru 80
— если открылось окно Telnet, значит соединение возможно.
Повторить попытку подключения (входа) в ИАС КХД
Сбой локальной сети Нет сетевого взаимодействия между рабочей станцией и сервером приложений ИАС КХД Отсутствует возможность начала (продолжения) работы с ИАС КХД. Нет сетевого подключения к серверу ИАС КХД Перезагрузить рабочую станцию.
Проверить доступность сервера ИАС КХД по порту 80, выполнив следующие команды:
— нажать кнопку «Пуск»
— выбрать пункт «Выполнить»
— в строке ввода набрать команду telnet ias_dwh.ru 80
— если открылось окно Telnet, значит соединение возможно.
После восстановления работы локальной сети повторить попытку подключения (входа) в ИАС КХД.

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

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

  • Oracle® Business Intelligence Discoverer Viewer User’s Guide
  • Oracle® Business Intelligence Discoverer Plus User’s Guide

Рекомендуемые курсы обучения:

  • Discoverer 10g: Создание запросов и отчетов

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

Источник

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

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

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

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

ГОСТ 19.505-79 Руководство оператора

Введение

Уровень подготовки пользователя

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

Назначение и условия применения

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

Назначение программы

Условия, при которых обеспечивается применение программы

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

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

Выполнение программы

Состав и содержание дистрибутивного носителя данных

Порядок загрузки данных и программ

Порядок загрузки, запуска и завершения программы

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

Описание функций

Описание всех выполняемых функций, задач, комплексов задач, процедур

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

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

Сообщения оператору

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

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

  • Назначение системы;
  • Условия применения системы;
  • Подготовка системы к работе;
  • Описание операций;
  • Аварийные ситуации.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Дата создания проекта – текущая дата;
  • Автор – ИФО и должность автора проекта.»

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

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

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

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

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

На нашем сайте вы можете скачать шаблон документа Руководство пользователя, выполненный в формате Word.

Источник