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

Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 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. Рекомендации по освоению

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

Документ «Руководство пользователя»

Документ «Руководство пользователя»

РД 50-34.698-90. Автоматизированные системы. Требования к содержанию документов: <…>.

УКАЗАНИЯ ГОСТ:
Настоящие методические указания распространяются на автоматизированные системы (АС), используемые в различных сферах деятельности (управление, исследование, проектирование и т. п.), включая их сочетание, и устанавливают требования к содержанию документов, разрабатываемых при создании АС.

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

1. Структура документа:
2. 1. Введение
3. 1.1 Область применения
4. 1.2 Краткое описание возможностей
5. 1.3 Уровень подготовки пользователя
6. 1.4 Перечень эксплуатационной документации
7. 2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ
8. 2.1 Виды деятельности, функции
9. 2.2 Программные и аппаратные требования к системе
10. 3 ПОДГОТОВКА К РАБОТЕ
11. 3.1 Состав дистрибутива
12. 3.2 Запуск системы
13. 3.3 Проверка работоспособности системы
14. 4 ОПИСАНИЕ ОПЕРАЦИЙ
15. 4.1 Наименование операции
16. 4.2 Условия выполнения операции
17. 4.3 Подготовительные действия
18. 4.4 Основные действия
19. 4.5 Заключительные действия
20. 4.6 Ресурсы, расходуемые на операцию
21. 5 АВАРИЙНЫЕ СИТУАЦИИ. ВОССТАНОВЛЕНИЕ БАЗЫ ДАННЫХ
22. 6 РЕКОМЕНДАЦИИ ПО ОСВОЕНИЮ

УКАЗАНИЯ ГОСТ:
Документ содержит разделы:
1) введение;
2) назначение и условия применения;
3) подготовка к работе;
4) описание операций;
5) аварийные ситуации;
6) рекомендации по освоению.

1. Введение

1.1 Область применения

ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа «Техническое задание, п.п.2.1».

1.2 Краткое описание возможностей

ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа «Описание автоматизируемых функций, п.п.2.».

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

ПРИМЕР СОДЕРЖАНИЯ:
Наполнение данного раздела можно взять из документа «Техническое задание, п.п.4.1.2 Требования к численности и квалификации персонала системы»

1.4 Перечень эксплуатационной документации

ПРИМЕР СОДЕРЖАНИЯ:
Перечень эксплуатационных документов, с которым необходимо ознакомиться:
— АС Кадры. «Руководство администратора»;
— АС Кадры. «Руководство пользователя»;
— т.д.
— пр.;

2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ

УКАЗАНИЯ ГОСТ:
В разделе «Назначение и условия применения» указывают:
1) виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
2) условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

ПРИМЕР СОДЕРЖАНИЯ:

2.1 Виды деятельности, функции

ПРИМЕР СОДЕРЖАНИЯ:
АС Кадры предназначена для автоматизации следующих видов деятельности:
Наполнение раздела можно взять в документе «Описание автоматизируемых функций, раздел ЦЕЛИ АС И АВТОМАТИЗИРУЕМЫЕ ФУНКЦИИ».

2.2 Программные и аппаратные требования к системе

ПРИМЕР СОДЕРЖАНИЯ:
Пример требований к программному обеспечению приведен в документе «Пояснительная записка, п.п.3.10».
Пример требований к аппаратному обеспечению приведен в документе «Техническое задание, п.п.4.3.5».

3 ПОДГОТОВКА К РАБОТЕ

УКАЗАНИЯ ГОСТ:
В разделе «Подготовка к работе» указывают:
1) состав и содержание дистрибутивного носителя данных;
2) порядок загрузки данных и программ;
3) порядок проверки работоспособности.

3.1 Состав дистрибутива

ПРИМЕР СОДЕРЖАНИЯ:
В состав дистрибутива АС Кадры входит:
— СУБД Oracle 10.2g;
— Приложение установки базы данных;
— Серверная часть Windows приложения АС Кадры;
— Клиентская часть Windows приложения;
— т.д.;
— пр.

3.2 Запуск системы

ПРИМЕР СОДЕРЖАНИЯ:
Предварительно необходимо выполнить установку системы. Информацию об установке системы можно получить в документе РД И3(А) АС Кадры, который входит в состав проектной документации.
1. Для того, чтобы запустить АС Кадры, откройте папку, в которую была установлена программа, и запустите файл kadry.exe.
2. В открывшемся окне заполните следующие поля в области окна Общие параметры:
— Логин — логин (логическое имя) пользователя;
— Пароль — пароль для входа в систему;
3. т.д.
пр.

3.3 Проверка работоспособности системы

ПРИМЕР СОДЕРЖАНИЯ:
Программное обеспечение работоспособно, если в результате действий пользователя, изложенных в п.п.3.2, на экране монитора отобразилось главное окно клиентского приложения без выдачи пользователю сообщений о сбое в работе.

4 ОПИСАНИЕ ОПЕРАЦИЙ

УКАЗАНИЯ ГОСТ:
В разделе «Описание операций» указывают:
1) описание всех выполняемых функций, задач, комплексов задач, процедур;
2) описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.
Для каждой операции обработки данных указывают:
1) наименование;
2) условия, при соблюдении которых возможно выполнение операции;
3) подготовительные действия;
4) основные действия в требуемой последовательности;
5) заключительные действия;
6) ресурсы, расходуемые на операцию.

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

4.1 Наименование операции

ПРИМЕР СОДЕРЖАНИЯ:
Просмотр справочной информации.

4.2 Условия выполнения операции

ПРИМЕР СОДЕРЖАНИЯ:
Приложение запущено, успешно функционирует, не выполняет никакх операций, блокирущих доступ к пунктам меню.

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

ПРИМЕР СОДЕРЖАНИЯ:
Отсутствуют.

4.4 Основные действия

ПРИМЕР СОДЕРЖАНИЯ:
Открыть пункт меню «Помощь», выбрать раздел «Справка». Появится всплывающее окно, содержащее разделы со справкой.

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

ПРИМЕР СОДЕРЖАНИЯ:
После завершения работы со справочной информацией, закрыть вплывающее окно со справкой.

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

ПРИМЕР СОДЕРЖАНИЯ:
Отсутствуют.

5 АВАРИЙНЫЕ СИТУАЦИИ. ВОССТАНОВЛЕНИЕ БАЗЫ ДАННЫХ

УКАЗАНИЯ ГОСТ:
В разделе «Аварийные ситуации» указывают:
1) действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств;
2) действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных;
3) действия в случаях обнаружении несанкционированного вмешательства в данные;
4) действия в других аварийных ситуациях

ПРИМЕР СОДЕРЖАНИЯ:
При сбое в работе аппаратуры восстановление нормальной работы системы должно производиться после:
— перезагрузки операционной системы;
— запуска исполняемого файла системы;

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

6 РЕКОМЕНДАЦИИ ПО ОСВОЕНИЮ

УКАЗАНИЯ ГОСТ:
В разделе «Рекомендации по освоению» указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

ПРИМЕР СОДЕРЖАНИЯ:
Для успешного освоения приложения АС Кадры необходимо иметь навыки работы с ПК и изучить следующее:
— Нормативно-правовую базу по вопросам управления государсвенными кадрами;
— Раздел «Описание процесса деятельности» документа «Пояснительная записка (Технический проект)»;
— Раздел «Описание автоматизируемых функций» документа «Пояснительная записка (Технический проект)»;
— Настоящее «Руководство пользователя».

Контрольный пример работы с системой
Ниже рассмотрен пример работы с системой, начиная с ее запуска и заканчивая оформлением документов:
1. Запустите систему.
2. т.д.
3. пр.

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

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

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

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

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

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

1. Введение.

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

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

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

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

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

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

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 в составе ИАС КХД доступна
всем пользователям с установленными
правами доступа.

Соседние файлы в папке TZ

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

Руководство ориентировано на пользователей, владеющих основными приемами работы в операционной системе Windows и стандартным программным обеспечением MS Office (типа Word, Excel).

1.4.Перечень документации, с которой необходимо ознакомиться

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

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

Для начала работы с Системой (запуска Системы) следует:

• щелкнуть два раза по ярлыку Системы на «рабочем столе». Также можно нажать на кнопку «Пуск» и выбрать в открывшемся меню ярлык Системы;
• откроется окно для ввода данных регистрации:

Рис. 2.1. Окно регистрации пользователя.

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

Примечание. Если нажать на кнопку «Отмена», то вход в Систему будет прекращен.

В случае неверного ввода значений появится сообщение:

Рис. 2.2. Сообщение в случае ввода неверной информации.

Нажмите на кнопку «ОК» и введите корректные данные.

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

3.1.Задача «Штатное расписание»

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

3.1.1.Режим «Ведение структуры подразделений (дерево)»

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

Рис. 3.1 Окно «Ведение структуры подразделений (дерево)»

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

Для просмотра и изменения данных уже существующего подразделения необходимо выбрать его в иерархическом списке левой части окна. Для раскрытия списка установите курсор на строчке «Центральный Аппарат» и щелкните левой кнопкой мыши – отобразятся подразделения первого уровня иерархии (см. Рис. 3 .2).

Рис. 3.2 Древовидная структура подразделений после нажатия на строчку «Центральный Аппарат»

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

Если искомое подразделение находится на уровне, лежащем ниже, то следует установить курсор над наименованием подразделения, включающего в себя искомое, и вновь щелкнуть левой кнопкой мыши. Вид левой части окна изменится – теперь в ней будет открыт второй уровень иерархии (см. Рис. 3 .3).

Рис. 3.3 Древовидная структура подразделений. Открыт второй уровень иерархии

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

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

Для добавления нового подразделения нажмите в нижней части информационного окна режима на кнопку «Новая запись«. После этого в правой части окна появится пустая форма для ввода данных по новому подразделению (см. Рис. 3 .4).

Рис. 3.4 Пустая форма для ввода данных по новому подразделению

При добавлении нового подразделения необходимо заполнить следующие поля:

• Наименование вышестоящего подразделения – название подразделения, в состав которого входит данное. По умолчанию поле содержит название подразделения, выделенного в иерархическом списке левой части окна на момент нажатия на кнопку «Новая запись«;
• Уровень подразделения – уровень, занимаемый данным подразделением в общей структуре. По умолчанию поле заполняется значением на разряд ниже уровня вышестоящего подразделения;
• Код – порядковый номер подразделения на занимаемом им уровне иерархии;
• № п/п. – полный (по всем уровням иерархии) порядковый номер подразделения. Поле заполняется автоматически после нажатия на кнопку «Сохранить«. При этом последняя цифра дублирует значение предыдущего поля Код, левее идут два нуля, ещё левее – цифры, представляющие собой порядковые номера подразделений, стоящих выше по иерархии. Этот же номер будет отображен в иерархическом списке левой части окна в строчке, соответствующей данному подразделению;
• Полное наименование – введите полное наименование подразделения;
• Краткое наименование – введите с клавиатуры краткое наименование данного подразделения;
• Наименование в родительном падеже – введите наименование подразделения в родительном падеже. Данная информация будет использоваться при распечатке различных документов, упоминающих данное подразделение;
• № док-та об образовании – номер приказа об образовании данного структурного подразделения;
• Дата док-та об образовании, Дата образования – соответственно дата приказа об образовании и непосредственно образования данного структурного подразделения. По умолчанию заполняются условной датой, но значения можно отредактировать вручную.

После заполнения нужных полей нажмите на кнопку «Сохранить«.

3.1.1.1.Структура подразделения

Далее необходимо создать структуру нового подразделения (фактически – определить его штатные единицы). Для работы со штатным расписанием структурного подразделения (добавления/редактирования штатных единиц) сначала укажите наименование этого подразделения в древовидной структуре информационного окна. Далее перейдите в правую часть окна и нажмите кнопкой мыши на пиктограмму в левом верхнем углу формы. Выберите в появившемся контекстном меню пункт «Структура подразделения». На экране появится требующееся информационное окно (см. Рис. 3 .5).

Рис. 3.5 Окно «Структура подразделения»

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

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

• Должность – нажмите на кнопку и выберите из списка должность, соответствующую данной штатной единице;
• Количество по штату – введите количество штатных единиц по данной должности;
• Оклад – значение оклада на данной должности;
• Надбавка за госслужбу % – введите величину надбавки за госслужбу в процентах;
• № документа об образовании – номер приказа об образовании данной вакансии;
• Дата документа об образовании, Дата образования – соответственно дата приказа об образовании и непосредственно образования данной вакансии. По умолчанию заполняются условной датой, но значения можно отредактировать вручную.

После того как ввели структуру подразделения, нажмите в окне «Ведение структуры подразделений» на кнопку «Ввести в шт. расп.«. После этого подразделение с его структурой будет введено в штатное расписание, и можно приступать к работе с режимом «Ведение штатного расписания» (см. подраздел 3.1.4).

3.1.2.Режим «Общий список подразделений»

Данный режим работы почти полностью аналогичен режиму «Ведение структуры подразделений (дерево)«. Для открытия его информационного окна следует в списке режимов работы Навигатора выбрать пункт «Общий список подразделений» (Штатное расписание –> Общий список подразделений).

Здесь также можете создать новое подразделение, сформировать его структуру и ввести в штатное расписание, а также упразднить подразделение. В основном режимы различаются только внешним оформлением (см. Рис. 3 .6).

Рис. 3.6 Окно «Общий список подразделений».

Самое главное отличие – в данном режиме можете работать как с действующими, так и с упраздненными или проектными подразделениями. Состояние подразделений указывается при формировании запроса в Конфигураторе (см. Рис. 3 .7).

Рис. 3.7 Указание состояния подразделений в Конфигураторе

3.1.3.Режим «Сводная структура подразделений»

Данный режим (см. Рис. 3 .8) предназначен для ввода, просмотра и коррекции структуры подразделений (фактически – количества штатных единиц). Для открытия информационного окна следует в списке режимов работы Навигатора выбрать пункт «Сводная структура подразделений» (Штатное расписание –> Сводная структура подразделений).

Режим аналогичен режиму «Ведение структуры подразделений» (см. 3.1.1). Единственное отличие – в данном режиме можно с помощью конфигуратора запросов получить доступ к структуре

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

Рис. 3.8 Окно «Сводная структура подразделений»

3.1.4.Режим «Ведение штатного расписания»

Данный режим (см. Рис. 3 .9) предназначен для работы со штатным расписанием. В нем производится назначение, увольнение, переназначение и открепление работников. Также данный режим может использоваться для подготовки и печати отчетов, получения статистических данных. Для открытия информационного окна следует в списке режимов работы Навигатора выбрать пункт «Ведение штатного расписания» (Штатное расписание –> Ведение штатного расписания).

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

Рис. 3.9 Окно «Ведение штатного расписания».

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

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

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

Рис. 3.10 Просмотр информации о штатной единице, входящей в подразделение

В этом случае в верхней части экрана увидите информацию: слева – о выбранной штатной единице, справа – о работнике, на неё назначенном. Кроме того, нажав кнопку , расположенную справа от поля Фамилия Имя Отчество, можете открыть Личную карточку сотрудника и просмотреть полную информацию о работнике.

Для назначения работника на должность используется кнопка . После нажатия откроется форма, содержащая проект приказа о назначении, которую нужно будет заполнить.

Для увольнения работника используется кнопка . После нажатия откроется форма, содержащая проект приказа об увольнении, которую нужно будет заполнить.

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

3.1.5.Режим «Ведение справочника должностей»

Данный режим (см. Рис. 3 .11) предназначен для ведения справочника должностей. Для открытия его информационного окна следует в списке режимов работы Навигатора выбрать пункт «Ведение справочника должностей» (Штатное расписание–> Ведение справочника должностей).

Рис. 3.11 Окно режима «Ведение справочника должностей».

При вводе новой должности заполняются следующие поля:

• текстовые – Наименование, Краткое наименование; Род. падеж, Дат. падеж, Творит. падеж — наименование в падежах;
• числовые – Код (код должности), Уровень; Min оклад, Max оклад – предельные значения возможной величины оклада для данной должности; min надб/оу, max надб/оу – предельные значения возможной величины надбавки за особые условия госслужбы для данной должности (в %); Ежемес. поощр., Ежекв. поощр. – величина ежемесячного/ежеквартального поощрения для данной должности;
• справочники – Категория (категория должности – А, Б, В, нет), Группа должностей (Высшая, Главная, Ведущая, Старшая, Младшая, —), Тип должности (Гос. должность/Не гос. должность).

В нижней части формы можете увидеть состояние данной должности (действующие, упраздненные или проектные должности). Чтобы упразднить должность, нужно заполнить поля Дата упразд. и На основании док-та (реквизиты документа об упразднении должности), поменять значение поля Состояние должности на «Упраздненные должности» и нажать на кнопку «Сохранить«.

Практическая работа №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 «Руководство оператора. Требования к содержанию и оформлению». Ниже для
сравнения приведены структуры документа согласно двум перечисленным стандартам.

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

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

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

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

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

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

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

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

Пример:

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

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

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

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

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

Квалификация
пользователя – данный подраздел должен содержать требования к навыкам и знаниям
пользователя (пример: «Пользователи должны обладать навыками работы с
операционной системой 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) либо к
ответственному Администратору ИАС КХД.

Класс ошибки	Ошибка	Описание ошибки	Требуемые действия пользователя при возникновении ошибки
Портал ИАС КХД	Сервер не найден. Невозможно отобразить страницу	Возможны проблемы с сетью или с доступом к порталу ИАС КХД.	Для устранения проблем с сетью обратиться к сотруднику подразделения технической поддержки (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. настоящего документа.

Ход
работы:

Задание 1.
Изучите
свой вариант руководства пользователя. Опишите его по следующему плану:

1) для
какого продукта, предназначено руководство пользователя (наименование, модель);

2)
основные технические характеристики продукта;

3)
основные разделы руководства пользователя (название раздела и краткое его
описание)

Задание 2.
Откройте 
документ «Образец руководства пользователя», заполните в нем первые разделы для
своего вымышленного программного продукта.

Сделайте
вывод
о проделанной работе.

Контрольные
вопросы:

1) Дайте
определения понятиям «руководство пользователя», «инструкция по эксплуатации»

2) Какие
основные разделы должно содержать руководство пользователя?

3) Какие
стандарты описывают Руководство пользователя Руководство оператора, Руководство
программиста, Руководство системного программиста?

4) Что
описывает раздел «назначение системы»?

5) Что
указывается в разделе «условия применения системы»?

6) Какая
информация содержится в разделе «Описание операций»?