СОПРОВОЖДЕНИЕ И ОБСЛУЖИВАНИЕ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ КОМПЬЮТЕРНЫХ СИСТЕМ. Методические указания по выполнению практических и лабораторных работ по пм. 04
 Скачать 1.92 Mb.
|
|
Практическая работа № 4.2. Разработка руководства оператора Цель работы: изучение нормативно правовой документации, регламентирующей раз- работку документации на программные средства. Основу отечественной нормативной базы в области документирования ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и боль- шая часть комплекса ЕСПД была разработана в 70-е и 80-е годы. Стандарты ЕСПД в основном охватывают ту часть документации, которая создается в процессе разработки ПС, и связаны, по большей части, с документированием функциональных характеристик ПС. Согласно ЕСПД программный документ – это документ, содержащий сведения, необхо- димые для разработки, изготовления, эксплуатации и сопровождения программного изделия. Номенклатуру программных документов определяет ГОСТ 19.101-77 «ЕСПД. Виды программ и программных документов». В качестве основных видов программстандартом определяются: § компоненты – программы, рассматриваемые как единое целое, выполняющие закон- ченную функцию и применяемые самостоятельно или в составе комплекса; § комплексы – программы, состоящие из двух или более компонентов, выполняющие взаимосвязанные функции и применяемые самостоятельно или в составе другого комплекса. Виды программных документов и их краткое содержание представлены в стандарте опи- саниями, приведенными в таблице 1. Таблица 1. Виды программных документов Вид доку- мента Содержание документа Спецификация Состав программы и документация на ее Ведомость дер- жателей под- линников Перечень предприятий, на которых хранятся подлинники программных документов Текст про- граммы Запись программы с комментариями 10 Описание Сведения о логической структуре программы и функционировании программы Программа и методика ис- пытаний Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля Техническое задание Назначение и область применения программы; технические, технико-эко- номические и специальные требования, предъявляемые к программе; не- обходимые стадии и сроки разработки; виды испытаний Пояснительная записка Схема алгоритма, общее описание алгоритма и (или) функционирова- ния программы, а также обоснование принятых технических и технико- экономических решений Эксплуатаци- онные доку- менты Сведения для обеспечения функционирования и эксплуатации программы Перечень эксплуатационных документов, рекомендуемых ЕСПД, представлен в табл. 2. Таблица 2. Виды эксплуатационных документов вид документа Содержание документа Ведомость Перечень эксплуатационных документов на программу эксплуатационных документов Формуляр Основные характеристики программы, комплектность и сведения об эксплуатации программы Описание Сведения о назначении программы, применения области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств Руководство Сведения для проверки, обеспечения системного функционирования и настройки программиста программы на условия конкретного применения Руководство Сведения для эксплуатации программы программиста Руководство Сведения для обеспечения процедуры оператора общения оператора с вычислительной (пользователя) системой в процессе выполнения программы Описание языка Описание синтаксиса и семантики языка Руководство по Сведения для применения тестовых и техническому диагностических программ при обслуживанию обслуживании технических средств Допускается объединение отдельных видов эксплуатационных документов (за исключе- нием ведомости эксплуатационных документов и формуляра), необходимость объединения указывается в техническом задании. Объединенному документу присваивают наименование и 11 обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ. ГОСТ 19.701-90 (ИСО 5807-85) "Единая система программной документации. Схемы алгоритмов, программ, данных и систем. Обозначения условные и правила вы- полнения". Стандарт распространяется наусловные обозначения (символы) в схемах алгорит- мов, программ, данных и систем и устанавливает правила выполнения схем, используемых для отображения различных видов задач обработки данных и средств их решения. В РФ действует ряд стандартов в части документирования ПС, разработанных на ос- нове прямого применения международных стандартов ИСО. ГОСТ Р ИСО/МЭК 9294-93 «Информационнаятехнология. Руководство по управлению документированием программного обеспечения». Стандартустанавливает ре- комендации по эффективному управлению документированием ПС для руководителей, отвеча- ющих за их создание. Целью стандарта является оказание помощи в определении стратегии документирования ПС; выборе стандартов по документированию; выборе процедур докумен- тирования; определении необходимых ресурсов; составлении планов документирования. ГОСТ Р ИСО 9127-94 «Системы обработки информации. Документация пользова- теля и информация на упаковке для потребительских программных пакетов». В контек- стенастоящего стандарта под потребительским программным пакетом (ПП) понимается «про- граммная продукция, спроектированная и продаваемая для выполнения определенных функ- ций; программа и соответствующая ей документация, упакованные для продажи как единое це- лое». Под документацией пользователя понимается документация, которая обеспечивает ко- нечного пользователя информацией по установке и эксплуатации ПП. Под информацией на упаковке понимают информацию, воспроизводимую на внешней упаковке ПП. Ее целью явля- ется предоставление потенциальным покупателям первичных сведений о ПП. Содержание документа "Руководство пользователя" Документ "Руководство поль- зователя", разрабатывается на основании методических указаний РД 50-34.698-90. Данный до- кумент формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация». Состав руководства оператора в соответствии со стандартом 1. Введение. 2. Назначение и условия применения. 3. Подготовка к работе. 4. Описание операций. 5. Аварийные ситуации. 6. Рекомендации по освоению. Введение В разделе "Введение" указывают: область применения; краткое описание возможностей; уровень подготовки пользователя; перечень эксплуатационной документации, с которой необходимо ознакомиться поль- зователю. 1.1. Область применения Требования настоящего документа применяются при: предварительных комплексных испытаниях; опытной эксплуатации; приемочных испытаниях; промышленной эксплуатации. 1.2. Краткое описание возможностей Например: 12 Информационно-аналитическая система Корпоративное Хранилище Данных (ИАС КХД) предназначена для оптимизации технологии принятия тактических и стратегических управленческих решений конечными бизнес-пользователями на основе информации о всех ас- пектах финансово-хозяйственной деятельности Компании. ИАС КХД предоставляет возможность работы с регламентированной и нерегламен- тированной отчетностью. 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 в составе ИАС КХД доступна всем пользователям с установленными правами доступа. 3. Подготовка к работе В разделе "Подготовка к работе" указывают: состав и содержание дистрибутивного носителя данных; порядок загрузки данных и программ; порядок проверки работоспособности. 3.1. Состав и содержание дистрибутивного носителя данных Например: Для работы с ИАС КХД необходимо следующее программное обеспечение: Internet Explorer (входит в состав операционной системы Windows); 13 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: Регистрация на портале ИАС КХД Условия,при соблюдении которых возможно выполнениеоперации: Компьютер пользователя подключен к корпоративной сети. Портал ИАС КХД доступен. ИАС КХД функционирует в штатном режиме. 14 Подготовительные действия: · На компьютере оператора необходимо выполнить дополнительные настройки, приведенные в п. 3.2 настоящего документа. Основные действия в требуемой последовательности: На иконке «ИАС КХД» рабочего стола произвести двойной щелчок левой кнопкой мышки. В открывшемся окне в поле «Логин» ввести имя пользователя, в поле «Пароль» ввести пароль пользователя. Нажать кнопку «Далее». Заключительные действия: Не требуются. Ресурсы, расходуемые на операцию: 15-30 секунд. 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: Создание запросов и отчетов Ход работы 1. Подготовить документ (*.doc), содержащий структуру основных разделов руковод- ства оператора стандартного форматирования: шрифт TimesNewRoman, 12 пт, поля, межстроч- ный интервал - стандартные, как в техническом задании, имя файла - <ФИО студента. Руковод- ство пользователя>. 2. На основании технического задания на разработку (практическая работа МДК 03.01), заполнить разделы руководства оператора "Введение", "Назначение и условия применения", "Подготовка к работе". 3. Сохранить документ с именем (Фамилия, инициалы студента. Наименование работы). 4. Прикрепить файл руководства оператора в разделе Руководство оператора (практиче- ская работа 2) учебного сервера stud.scc 15 5. Используя почтовый-клиент Mozilla Thunderbird отослать письмо-отчет преподава- телю с указанием гиперссылки на стартовую страницу по адресу vlr@prep.scc или 90@192.168.5.90 6. Ответить на контрольные вопросы (или выполнить тест на ПК). 1. Перечислить состав разделов руководства пользователя. 2. Пояснить состав раздела «Введение». 3. Пояснить состав раздела «Назначение и условия применения2 применения». 4. Пояснить состав раздела «Подготовка к работе» 5. Пояснить состав раздела «Описание операций» 6. Пояснить состав раздела «Аварийные ситуации» 7. Пояснить состав подраздела «Рекомендации по освоению» Практическая работа 4.3. Разработка (подготовка) документации и от- четных форм для внедрения программных средств Цель работы: научиться составлять техническую документацию программного про- дукта. Теоретический материал Программная документация, включает: Техническое задание (назначение, область применения программы, требования, предъявляемые к программе); Текст программы (запись программы с необходимыми комментариями); Описание программы (сведения о логической структуре и функционировании про- граммы); Пояснительная записка (схема алгоритма, общее описание алгоритма и/или функцио- нирования программы, обоснование принятых решений); Эксплуатационные документы. К эксплуатационным документам относят: описание применения (сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств); руководство системного программиста (сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного примене- ния); руководство программиста (сведения для эксплуатации программы); руководство оператора (сведения для обеспечения общения оператора с вычис- лительной системой в процессе выполнения программы); описание языка (описание синтаксиса и семантики языка); руководство по техническому обслуживанию (сведения для применения тесто- вых и диагностических программ при обслуживании технических средств) Основная часть программной документации составляется на стадии рабочего проекта. Необходимость того или иного документа определяется на этапе составления технического за- дания. Допускается объединять отдельные виды документов. Эксплуатационный документ "Описание языка" включается в программную документа- цию, если разработанный программный продукт реализует некий язык программирования, управления заданиями, организации вычислительного процесса и т. п. Эксплуатационный документ "Руководство по техническому обслуживанию" включа- ется в программную документацию, если разработанный программный продукт требует ис- пользования тестовых или диагностических программ. Описание применения 16 Документ "Описание применения" относится к эксплуатационным документам и со- стоит из следующих разделов: назначение программы (возможности, основные характеристики, ограничения области применения); условия применения (требования к техническим и программным средствам, об- щие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера); описание задачи (указываются определения задачи и методы её решения); входные и выходные данные. Руководство программиста Документ "Руководство программиста" относится к эксплуатационным документам и включается в программную документацию, если разработанный программный продукт требует обслуживания программистом. Документ состоит из следующих разделов: назначение и условия применения программы (назначение и функции про- граммы, сведения о технических и программных средствах, обеспечивающих вы- полнение данной программы); характеристики программы (временные характеристики, режимы работы, сред- ства контроля правильности выполнения и т. п.); обращение к программе (способы передачи управления и параметров данных); входные и выходные данные (формат и кодирование); сообщения (тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы и описание действий, которые необходимо предпринять по этим сообщениям). Руководство оператора Документ "Руководство оператора" относится к эксплуатационным документам и со- стоит из следующих разделов: назначение программы (информация, достаточная для понимания функций про- граммы и её эксплуатации); условия выполнения программы (минимальный и/или максимальный набор тех- нических и программных средств и т. п.); выполнение программы (последовательность действий оператора, обеспечиваю- щих загрузку, запуск, выполнение и завершение программы; описываются функции, форматы и возможные варианты команд, с помощью которых опера- тор осуществляет загрузку и управляет выполнением программы, а также от- веты программы на эти команды); сообщения оператору (тексты сообщений, выдаваемых оператору в ходе выпол- нения программы и описание действий, которые необходимо предпринять по этим сообщениям). |