Инструкция по эксплуатации программы

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

Кратко опишем основные функции, которые выполняет данное программное средство:

Простой и удобный запуск каждой задачи из единой программной оболочки.

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

Считывание, обработка и сохранение данных в файле.

Сортировка данных различного типа.

Удобная система завершения работы после выполнения каждой задачи и функция выхода из программного комплекса

Программный комплекс «Автоматизированная система обработки структур данных» предназначен для работы в операционных системах семейства Windows, состоит из файла progr. exe, никаких дополнительных программных компонентов для работы не требуется. В каталоге с программой также должен располагаться файл tab. pas для решения четвертой задачи.

Программирование в Manual Guide . Fanuc i0

Выполнение программы

Запуск программного комплекса осуществляется с помощью файла progr. exe. После этого мы попадаем в главное меню программы (рис.1):

Главное меню программного комплекса

Рис.1. Главное меню программного комплекса.

После выбора соответствующего номера мы попадаем в режим ввода данных той или иной задачи (рис.2):

Режим ввода данных для первой задачи

Рис.2. Режим ввода данных для первой задачи.

Если мы ввели данные не верно, то программа попросит повторить ввод (рис.3):

Действия программы при неверном вводе данных

Рис.3. Действия программы при неверном вводе данных.

Выдача результатов осуществляется после выполнения необходимых условий ввода данных (рис.4):

Выдача результатов работы первой задачи

Рис.4. Выдача результатов работы первой задачи.

После нажатия на клавишу Enter мы попадаем в главное меню программы, где можем продолжить работу или выйти из программы, введя цифру 5.

Описание контрольного примера

Рассмотрим пример нахождения наибольшего по модулю элемента матрицы и перемещения его в левый верхний угол матрицы с помощью перестановки двух строк или двух столбцов (Задача 2).

Итак, выбираем пункт два в главном меню программы и нажимаем Enter (рис.5):

Выбор режима работы программы

Рис.5. Выбор режима работы программы

Написание программы в MANUAL GUIDE I

Далее необходимо ввести размер действительной квадратной матрицы и ее элементы (Рис.6):

Ввод действительной квадратной матрицы

Рис.6. Ввод действительной квадратной матрицы

После этого получаем следующие результаты (рис.7):

Вывод результатов работы задачи 2

Рис.7. Вывод результатов работы задачи 2.

Число 7 — наибольшее значение матрицы стоит в левом верхнем углу преобразованной матрицы. Нажимаем Enter и возвращаемся в главное меню программного комплекса.

Рассмотрим пример работы третьей задачи.

Ввод данных осуществляется аналогичным для первой задачи образом (рис. 8)

Ввод данных для задачи 3

Рис.8. Ввод данных для задачи 3

После этого получаем следующие результаты (рис.9):

Вывод результатов работы задачи 3

Рис.9. Вывод результатов работы задачи 3

Получаем сумму соседних элементов массива, записанных вместо значений 4.0000 и 3.0000.

Рассмотрим пример работы с файлами. В главном меню выбираем пункт номер 4. Если файл tab. pas с нужными данными существует, то выдается следующее сообщение (рис.10):

Вывод результатов работы задачи 4

Рис.10. Вывод результатов работы задачи 4.

Результаты работы программы (отсортированный по дате набор данных) необходимо посмотреть в файле sort_tab. pas.

Если исходного файла не существует, то выдается ошибка (рис.11):

Отсутствие файла с данными

Рис.11. Отсутствие файла с данными

Источник: studbooks.net

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

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

Читайте также:
Какой программой прошивать Xiaomi

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

В книге С. Дж. Гримм [17] даны рекомендации по написанию подобной программной документации: • учитывайте интересы пользователей – руководство должно содержать все инструкции, необходимые пользователю; • излагайте ясно, используйте короткие предложения; • избегайте технического жаргона и узко специальной терминологии, если все же необходимо использовать некоторые термины, то их следует пояснить; • будьте точны и рациональны – длинные и запутанные руководства обычно никто не читает, например, лучше привести рисунок формы, чем долго ее описывать.

Руководство пользователя, как правило, содержит следующие разделы: • общие сведения о программном продукте; • описание установки; • описание запуска; • инструкции по работе (или описание пользовательского интерфейса); • сообщения пользователю. Раздел Общие сведения о программе обычно содержит наименование программного продукта, краткое описание его функций, реализованных методов и возможных областей применения. Раздел Установка обычно содержит подробное описание действий по установке программного продукта и сообщений, которые при этом могут быть получены. В разделе Запуск, как правило, описаны действия по запуску программного продукта и сообщений, которые при этом могут быть получены. Раздел Инструкции по работе обычно содержит описание режимов работы, форматов ввода-вывода информации и возможных настроек.

Раздел Сообщения пользователю должен содержать перечень возможных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

11.4. Руководство системного программиста

По ГОСТ 19.503–79 руководство системного программиста должно содержать всю информацию, необходимую для установки программного обеспечения, его настройки и проверки работоспособности. Кроме того, как указывалось выше, в него часто включают и описание необходимого обслуживания, которое раньше приводилось в руководстве оператора (ГОСТ 19.505–79) и/или руководстве по техническому обслуживанию (ГОСТ 19.508–79).

В настоящее время данную схему используют для составления руководства системному администратору. Руководство системного программиста должно содержать следующие разделы: • общие сведения о программном продукте, • структура, • настройка, • проверка, • дополнительные возможности, • сообщения системному программисту.

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

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

11.5. Основные правила оформления программной документации

При оформлении текстовых и графических материалов, входящих в программную документацию следует придерживаться действующих стандартов. Некоторые положения этих стандартов приведены ниже. Оформление текстового и графического материала. Текстовые документы оформляют на листах формата А4, причем графический материал допускается представлять на листах формата A3.

Читайте также:
Программа filecrypt32 может зашифровать сколько файлов

Поля на листе определяют в соответствии с общими требованиями: левое – не менее 30, правое – не менее 10, верхнее – не менее 15, а нижнее – не менее 20 мм. В текстовых редакторах для оформления записки параметры страницы заказывают в зависимости от устройства печати. При ручном оформлении документов параметры страницы выбирают из соображений удобства.

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

Расстояние между заголовками и текстом, а также между заголовками раздела и подразделов должно быть равно: • при выполнении документа машинописным способом – двум интервалам; • при выполнении рукописным способом – 10 мм; • при использовании текстовых редакторов – определяется возможностями редактора. Наименования подразделов и пунктов следует размещать с абзацного отступа и печатать вразрядку с прописной буквы, не подчеркивая и без точки в конце.

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

Разделы должны иметь порядковые номера 1, 2, и т. д. Номер подраздела включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой. Например: 2.1, 3.5. Ссылки на пункты, разделы и подразделы указывают, используя порядковый номер раздела или пункта, например, «в разд. 4», «в п. 3.3.4».

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

z : = sin(x)+ln(y); (12)

Ссылка на номер формулы дается в скобках. Например: «расчет значений проводится по формуле (12)». Оформление приложений. Каждое приложение должно начинаться с новой страницы с указанием в правом углу слова «ПРИЛОЖЕНИЕ» прописными буквами и иметь тематический заголовок.

При наличии более одного приложения все они нумеруются арабскими цифрами: ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д. Например: ПРИЛОЖЕНИЕ 2 Титульный лист расчетно–пояснительной записки Рисунки и таблицы, помещаемые в приложении, нумеруют арабскими цифрами в пределах каждого приложения с добавлением буквы «П». Например: Рис. П. 12 – 12-й рисунок приложения; Рис.

П1.2 – 2-й рисунок 1-го приложения. Если в приложении приводится текст программы, то каждый файл оформляют как рисунок с наименованием файла и его назначением, например: Рис. П2.4. Файл menuran.pas – программа движения курсора основного меню. Оформление списка литературы.

Список литературы должен включать все использованные источники. Сведения о книгах (монографиях, учебниках, пособиях, справочниках и т. д.) должны содержать: фамилию и инициалы автора, заглавие книги, место издания, издательство, год издания. При наличии трех и более авторов допускается указывать фамилию и инициалы только первого из них со словами «и др.». Издательство надо приводить полностью в именительном падеже: допускается сокращение названия только двух городов: Москва (М.) и Санкт–Петербург (СПб.). Сведения о статье из периодического издания должны включать: фамилию и инициалы автора, наименование статьи, издания (журнала), серии (ес-

Читайте также:
Программа с басковым где поют

Источник: studfile.net

Руководство по эксплуатации

Картинка Руководство по эксплуатации

Ткаченко Павел

Ткаченко Павел

03 октября, 2017

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

Навигация по странице:

  1. Понятие руководства по эксплуатации
  2. Статус руководства по эксплуатации в ряду прочих технических документов
  3. Области применения руководства по эксплуатации
  4. Дополнительные сферы применения РЭ

Понятие руководства по эксплуатации

Содержание термина «руководство по эксплуатации» принято трактовать в соответствии с положениями ГОСТ 2.601-2006 «Единая система конструкторской документации (ЕСКД). Эксплуатационные документы». Указанный национальный стандарт определяет данное руководство как важный документ, в котором содержится исчерпывающая информация о характеристиках продукта, его конструкции и принципах работы, правилах безопасной эксплуатации и осуществления работ с применением данного изделий.

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

Статус руководства по эксплуатации в ряду прочих технических документов

ГОСТ 2.601-2006 относит руководство по эксплуатации к разряду эксплуатационных документов наряду с инструкцией по монтажу, паспортом изделия, ведомостью наличия прилагаемых запчастей и проч. Таким образом, на данное руководство распространяются соответствующие правила Единой системы конструкторской документации (ЕСКД). В частности, это относится к положениям ГОСТ 2.610-2006 «Единая система конструкторской документации. Правила выполнения эксплуатационных документов».

Области применения руководства по эксплуатации

Эксплуатационные документы: руководство по эксплуатации

Требования ГОСТ 2.601-2006 устанавливают, что разработка руководства по эксплуатации не носит обязательного характера в отношении всех без исключения видов изделий: необходимость формирования этого документа определяется самим создателем продукции с учетом сложности его использования, необходимости применения дополнительной информации для корректной настройки и применения и других факторов. При этом в данном нормативно-правовом документе имеется оговорка о том, что в случае, если разработка конкретного продукта производится по заказу Министерства обороны РФ, именно это ведомство будет выступать в качестве органа, принимающего решение о необходимости разработки руководства по эксплуатации (РЭ).

Дополнительные сферы применения РЭ

Вместе с тем, при решении вопроса о необходимости создания РЭ для конкретного вида продукции разработчику необходимо учитывать, что такой документ позволяет пользователям изделий быть уверенными в правильности порядка его эксплуатации и обеспечивает безопасность персонала, работающего с тем или иным изделием. Поэтому при выпуске специального оборудования, предназначенного для использования в процессе работ на опасных производственных объектах, предоставление заказчикам РЭ является обязательным.

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

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

Таким образом, разработка РЭ – это ответственная процедура, к которой компании-производителю необходимо подойти с должной серьезностью.

Источник: www.centrattek.ru

Рейтинг
( Пока оценок нет )
Загрузка ...
EFT-Soft.ru