Тарасова_202_УП.04_ЛР6_Составление пользовательской документации. Лабораторная работа 6. Составление пользовательской документации
 Скачать 35.21 Kb.
|
|
Лабораторная работа №6. Составление пользовательской документации Цель работы: ознакомление с процедурой составления пользовательской (эксплутационной) документации к программному продукту. Основные теоретические сведения Эксплуатационная документация должна обеспечивать отчуждаемость ПС от их первичных разработчиков, адекватно отражать требуемое внешнее качество и качество в использовании, а также возможность освоения и эффективного применения ПС достаточно квалифицированными специалистами. Она применяется непосредственными пользователями в соответствии с функциональным назначением ПС, а также заказчиками, покупателямии поставщиками программных продуктов. Состав этой документации формируется с использованием части технологических документов с учетом требований заказчиков или потенциальных пользователей ПС. Содержание эксплуатационных документов должно предотвращать или исключать возможность некорректного использования комплекса программ пользователями за пределами условий эксплуатации, при которых поставщиком гарантируются требуемые и утвержденные характеристики качества функционирования ПС. При формировании эксплуатационных документов ПС, кроме базовых стандартов жизненного цикла могут использоваться ряд ведомственных нормативных документов и фирменных руководств. Эксплуатационная документация включает в себя: Документация администрирования при применении ПС; Документация операторов-пользователей при применении программного средства; Документация обучения специалистов применению ПС. Документация администрирования при эксплуатации информационной системы должна обеспечивать поддержку первичной инсталляции, штатного функционирования и восстановления программ и данных после сбоев и отказов. Управляющая деятельность администратора состоит в манипулировании управляемыми объектами и должна описываться, анализироваться и регламентироваться совокупностью требований и документов. Для этого необходима полная документация о компонентах информационной системы (компьютерах, сетевых устройствах), которые имеют свои особенности в управлении с помощью специальных программных компонентов, поддерживающих администрирование и управление системой. К основным функциям системы администрирования, документы для которых подлежат разработке и оцениванию, относятся: планирование использования памяти и производительности вычислительной системы в рабочем режиме применения ПС, оперативное управление и распределение ресурсов информационной системы; инсталляция и генерация рабочих версий ПС для оперативных пользователей; управление и учет внешней среды при выполнении адаптации и реконфигурации конкретного ПС; выявление, регистрация и накопление данных о сбоях и дефектах функционирования программ и данных; управление средствами защиты информации и санкционированного доступа пользователей, анализ попыток взлома системы защиты, восстановление программ и информации баз данных при искажениях; сбор и обобщение статистики о качестве функционирования ПС в составе системы обработки информации. Документация операторов-пользователей должна обеспечивать корректную и квалифицированную эксплуатацию комплекса программ во всем диапазоне его характеристик, предписанных требованиями заказчика и зафиксированных метриками в использовании. Объектами разработки и оценивания являются документы на процедуры и компоненты интерфейса с внешней средой и с пользователями, определяющие инициализацию соответствующих операций, их ход и результаты, а также комфортность их выполнения. Должно быть предусмотрено достаточное качество идентификации ошибочных действий и ситуаций, а также стандартизированной формы сообщений об ошибках пользователей. Приобретение, поставка, разработка, функционирование и сопровождение программных средств в значительной степени зависит от квалификации специалистов. Поэтому эксплуатационной документацией обязательно должно поддерживаться эффективное обучение персонала с целью его подготовки к приобретению, поставке, применению и сопровождению программного средства. Процесс обучения специалистов, контроль и учет результатов обучения с оцениванием достигнутой ими квалификации должен гарантировать, что соответствующие категории обученного персонала готовы для выполнения запланированных действий и решения задач с определенным программным средством. Результатом выполнения данной работы является пользовательская документация к разработанному ПП. Задания к практической части 1. Руководство оператора должно состоять из следующих частей: - Титульной; - Информационной; - Основной. Титульная часть оформляется согласно ГОСТ19.104-78 ЕСПД. Основные надписи. Информационная часть должна состоять из аннотации и содержания. В аннотации приводят сведения о назначении документа и краткое изложение основной части. Содержание включает перечень записей о структурных элементах основной части документа. Основная часть руководства оператора должна содержать следующие разделы: (ГОСТ19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению) Назначение программы содержит сведения о назначении программы иинформацию, достаточную для понимания функций программы. Условия выполнения программы должны содержать минимальный и максимальный состав аппаратурных и программных средств. Выполнение программы представляет собой последовательность действий оператора, обеспечивающих загрузку, выполнение и завершение программы, возможные варианты команд, которыми оператор может управлять выполнением программы, а также ответы программы на эти команды. Сообщения оператору содержат тексты сообщений, выдаваемых в ходе выполнения программы и соответствующие действия оператора, его действия в случае сбоя, повторного запуска программы. 2. Составить руководство оператора в соответствии с ГОСТ19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению. 3. Скомпоновать Руководство оператора в виде брошюры, в выбранной вами программе. 4. Требования к отчёту Отчёт должен содержать титульный лист, аннотацию, содержание и основную часть, оформленную в соответствии с ГОСТ19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению. СОГЛАСОВАНО УТВЕРЖДЕНО Руководитель ЦБ Начальник управления Личная Расшифровка Личная Расшифровка подпись подписи подпись подписи 13.06.2022 14.06.2022 ЕДИНАЯ СИСТЕМА ЭЛЕКТРОННАЯ ВЫЧИСЛИТЕЛЬНЫХ МАШИН ОПЕРАЦИОННАЯ СИСТЕМА Заказчик: Руководство программиста А.В.00001- 01 30 01-ЛУ Листок2 СОГЛАСОВАНО Преставители Руководитель ВЦ председателя разработчика Личная Расшифровка Главный инженер подпись подписи Личная Расшифровка 20000230 подпись подписи Главный менеджер 162238 Личная Расшифровка Начальник отдела подпись подписи Личная Расшифровка 20000230 подпись подписи 162209 Руководитель разработки Личная Расшифровка подпись подписи УТВЕРЖДАЮ А.В.00001- 01 30 01-ЛУ  1.1.ПРОГРАММА ОЧИСТКИ ОПЕРАТИВНОЙ ПАМЯТИ 2.Формуляр2.1.1.1.А.В.00001-01 30 01 2.ОБЩИЕ СВЕДЕНИЯ Наименование прграммного изделия: Архиватор Обозначение программного изделия: WinRaR.exe Наименование предприятия изготовителя: Norton и Microsoft Corparation Подразделение: группа РиВ АСУТП Антонов И.В.: вед. Инженер РиВ АСУТП Игоревич Н.У Номер программного изделия: 20406 Версия программного изделия: 3.06 Размер программного изделия: 22 880 Кб Дополнительные программы, необходимые для функционнирования данного программного изделия: Наименование программы: Наименование прграммногоизделия: Архиватор Обозначение программы WinRaR.exe Версия программного изделия: 3.06 3.ОСНОВНЫЕ ХАРАКТЕРИСТИКИ Программа «WinRaR», предназначена для архивации файлов. Исходным языком данной разработки является Visual Basic. Среда разработки, компилятор - Microsoft Visual Basic 6.0(локализованная русская версия). Основной функцией программы Defrag.exe является вызов каталога C:\Program Files\winrar\ программы стороннего разработчика WinRaR.exe. Дополнительно программа wubrar.exe проверяет наличие по указанному пути (C:\Program Files\Defrag\) исполняемого модуля программы WinRaR.exe, в случае его отсуствия, выдаётся сообщение «Файл WinRaR.exe не найден, переустановите программу». Основная задача вызываемой программы winrar (версия 3.06) - повысить производительность системы. Программы winrar реализует следующие функции: Архивация файлов Деархивация файлов Архивация/Деархивация архивов внутри архивов Данные функции программы winrar позволяют сжимать файлы и передавать их в сети интернет используя меньшее количество времени и трафика, а также эти файлы занимают меньшее количество места на диске. Контрольные вопросы: 1.Какая документация называется эксплуатационной? Эксплуатационная документация - это конструктивный документ, который в отдельности или в совокупности с другими документами определяет правила эксплуатации изделия и (или) отражает сведения, удостоверящие гарантированные изготовителем значения основных параметров и характеристик изделия, гарантии и сведения по его эксплуатации в течении установленного срока службы. 2.Что относится к эксплуатационной документации? К эксплуатационным документам относят текстовые, графические и мультимедийные конструкторские документы, которые в отдельности или в совокупности дают возможность ознакомления с изделием и определяют правила его эксплуатации. 3.Что относится к основным функциям системы администрирования? К основным функциям системы администратирования относят: предвидение организация распорядительство согласование и контроль. 4.Что должна обеспечивать документация операторов-пользователей? Документация операторов-пользователей должна обеспечивать корректную и квалифицированную эксплуатацию комплекса программ во всем диапазоне его характеристик, предписанных требованиями заказчика и зафиксированных метриками в использовании. |