Руководство пользователя
 Скачать 37.43 Kb.
|
Практическая работа №13Тема: Руководство пользователя. Цель работы: Ознакомиться с видами руководства пользователя, изучить нормативно правовую документацию, регламентирующую разработку руководств пользователя, приобрести навыки разработки руководства пользователя программного средства. Теоретические сведения. Руководство пользователя (userguide или 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. Введение В разделе "Введение" указывают: область применения; краткое описание возможностей; уровень подготовки пользователя; перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю. 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 В разделе "Назначение и условия применения" указывают: виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации; условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.). Oracle Discoverer Plus в составе ИАС КХД предназначен для автоматизации подготовки, настройки отчетных форм по показателям деятельности, а также для углубленного исследования данных на основе корпоративной информации хранилища данных. Работа с Oracle Discoverer Plus в составе ИАС КХД возможна всегда, когда есть необходимость в получении информации для анализа, контроля, мониторинга и принятия решений на ее основе. Работа с Oracle Discoverer Plus в составе ИАС КХД доступна всем пользователям с установленными правами доступа. 3. Подготовка к работе В разделе "Подготовка к работе" указывают: состав и содержание дистрибутивного носителя данных; порядок загрузки данных и программ; порядок проверки работоспособности. 3.1. Состав и содержание дистрибутивного носителя данных Для работы с ИАС КХД необходимо следующее программное обеспечение: Internet Explorer (входит в состав операционной системы Windows); Oracle JInitiator устанавливается автоматически при первом обращении пользователя к ИАС КХД. 3.2. Порядок загрузки данных и программ Перед началом работы с ИАС КХД на рабочем месте пользователя необходимо выполнить следующие действия: Необходимо зайти на сайт ИАС КХД ias-dwh.ru. Во время загрузки в появившемся окне "Предупреждение о безопасности", которое будет содержать следующее: 'Хотите установить и выполнить "Oracle JInitiator" ...' Нажимаем на кнопку "Да". После чего запуститься установка Oracle JInitiator на Ваш компьютер. Выбираем кнопку Next и затем OK. 3.3. Порядок проверки работоспособности Для проверки доступности ИАС КХД с рабочего места пользователя необходимо выполнить следующие действия: Открыть Internet Explorer, для этого необходимо кликнуть по ярлыку «Internet Explorer» на рабочем столе или вызвать из меню «Пуск». Ввести в адресную строку Internet Explorer адрес: ias-dwh.ru и нажать «Переход». В форме аутентификации ввести пользовательский логин и пароль. Нажать кнопку «Далее». Убедиться, что в окне открылось приложение Oracle Discoverer Plus. В случае если приложение Oracle Discoverer Plus не запускается, то следует обратиться в службу поддержки. 4. Описание операций В разделе "Описание операций" указывают: описание всех выполняемых функций, задач, комплексов задач, процедур; описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур. Для каждой операции обработки данных указывают: наименование; условия, при соблюдении которых возможно выполнение операции; подготовительные действия; основные действия в требуемой последовательности; заключительные действия; ресурсы, расходуемые на операцию. В описании действий допускаются ссылки на файлы подсказок, размещенные на магнитных носителях. 4.1. Выполняемые функции и задачи Oracle Discoverer Plus в составе ИАС КХД выполняет функции и задачи, приведенные в таблице ниже:
4.2. Описание операций технологического процесса обработки данных, необходимых для выполнения задач Ниже приведено описание пользовательских операций для выполнения каждой из задач. Задача: «Визуализация отчетности» Операция 1: Регистрация на портале ИАС КХД Условия, при соблюдении которых возможно выполнение операции: Компьютер пользователя подключен к корпоративной сети. Портал ИАС КХД доступен. ИАС КХД функционирует в штатном режиме. Подготовительные действия: На компьютере пользователя необходимо выполнить дополнительные настройки, приведенные в п. 3.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) Какая информация содержится в разделе «Описание операций»? |