Файл: Разработка эксплуатационной документации на программное средство.doc
ВУЗ: Не указан
Категория: Не указан
Дисциплина: Не указана
Добавлен: 03.12.2023
Просмотров: 111
Скачиваний: 3
ВНИМАНИЕ! Если данный файл нарушает Ваши авторские права, то обязательно сообщите нам.
Практическая работа №12
Тема: Разработка эксплуатационной документации на программное средствоЦель: - приобретение практических навыков по разработке эксплуатационной документации на программные средства различного назначения согласно требованиям стандартов ЕСПД.Вид работы: фронтальныйВремя выполнения: 2 часаТеоретические сведенияГОСТ 19.503. Руководство системного программиста. Требования к содержанию и оформлениюСоставление информационной части (аннотации и содержания) является обязательным.Руководство системного программиста должно содержать следующие разделы:• общие сведения о программе;• структура программы;• настройка программы;• проверка программы;• дополнительные возможности;• сообщения системному программисту.В разделе «Общие сведения о программе» должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.В разделе «Структура программы» должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.В разделе «Настройка программы» должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.). При необходимости приводят поясняющие примеры.В разделе «Проверка программы» должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.В разделе «Сообщения системному программисту» должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).ГОСТ 19.504. Руководство программиста. Требования к содержанию и оформлениюСоставление информационной части (аннотации и содержания) является обязательным.Руководство программиста должно содержать следующие разделы:• назначение и условия применения программы;• характеристика программы;• обращение к программе;• входные и выходные данные;• сообщения.В зависимости от особенностей ПС в документе допускается объединять отдельные разделы или вводить новые.В разделе «Назначение и условия применения программы» должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).ГОСТ 19.505. Руководство оператора. Требования к содержанию и оформлениюСоставление информационной части (аннотации и содержания) является обязательным.Руководство оператора должно содержать следующие разделы:• назначение программы;• условия выполнения программы;• выполнение программы;• сообщения оператору.В зависимости от особенностей ПС в документе допускается объединять отдельные разделы или вводить новые.
В разделе «Назначение программы» должны быть указаны сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации.В разделе «Условия выполнения программы» должны быть указаны условия, необходимые для выполнения программы (минимальный и/или максимальный состав аппаратных и программных средств и т.п.).В разделе «Выполнение программы» должна быть указана последовательность действий оператора, обеспечивающая загрузку, запуск, выполнение и завершение программы, приведено описание функций, формата и возможных вариантов команд, с помощью которых оператор осуществляет загрузки и управляет выполнением программы, а также ответы программы на эти команды.В разделе «Сообщения оператору» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.).Допускается содержание разделов иллюстрировать поясняющими примерами, таблицами, схемами, графиками.В приложении к руководству оператора допускается включать различные материалы, которые нецелесообразно включать в разделы руководства.ГОСТ 19.508. Руководство по техническому обслуживанию. Требования к содержанию и оформлениюНастоящий стандарт распространяется на тестовые и диагностические программы, используемые при обслуживании технических средств.Составление информационной части (аннотация и содержание) является обязательным.Руководство по техническому обслуживанию должно содержать следующие разделы:• введение;• общие указания;• требования к техническим средствам;• описание функций.В зависимости от особенностей ПС в документе допускается вводить дополнительные разделы.В разделе «Введение» указывают назначение руководства, перечень эксплуатационных документов, которыми должны дополнительно к руководству пользоваться при техническом обслуживании.В разделе «Общие указания» указывают порядок технического обслуживания, приводят указание по организации и особенностям его проведения.В разделе «Требования к техническим средствам» указывают минимальный состав технических средств, обеспечивающий работу программы.
В разделе «Описание функций» указывают:• максимальный состав технических средств, проверяемых этой программой;• описание совместного функционирования технических средств и программы с указанием метода обработки ошибок;• описание организации входных и выходных данных, используемых при обслуживании технических средств;• описание взаимодействий устройств с программой, результатов взаимодействий, с выводом результатов работы программы.Задания к практической работеПредлагается разработать следующую эксплуатационную документацию с соблюдением требований ЕСПД по их структуре и содержанию: • руководство системного программиста; • руководство программиста; • руководство оператора; • руководство по техническому обслуживанию. В зависимости от предметной области и вида ПС, выданного в качестве задания, возможно изменение преподавателем состава и содержания технологической документации. Например, возможна разработка руководства пользователя, которое может рассматриваться как документ, объединяющий руководства системного программиста, программиста и оператора. В документации обязательно должны быть приведены таблицы, схемы, иллюстрации, копии экранов, поясняющие положения документов.1. Изучите и законспектируйте теоретический материал «Единая система программной документации», обратив особое внимание на следующие вопросы:2. Ответить на контрольные вопросы. 3. Используя результаты практической работы № 11, последовательно разработать эксплуатационную документацию на заданное ПС, выполнив требования ЕСПД к ее содержанию и оформлению. 4. Отчетом по практической работе является оформленная документация.Контрольные вопросы
-
Дайте определение понятию «Единая система программной документации». -
Какими свойствами должна обладать документация пользователя? -
Дайте краткую характеристику документации пользователя. -
Объясните смысл понятия «документация пользователя».