Техническое описание работы программы

Содержание

Документ Описание программы ориентирован на документальное описание результирующего продукта разработки.

Этот документ создан на базе двух разных стандартов: ГОСТ 19.402-78 ЕСПД. «Описание программы» и ГОСТ 19.502-78 ЕСПД. «Описание применения. Требования к содержанию и оформлению», которые имеют между собой много общего и позволяют объединить их в одном общем документе, названном «Описание программы».

Описание программы может быть дополнено разделами и пунктами, взятыми и из стандартов для других описательных документов и руководств: ГОСТ 19.404-79 ЕСПД. «Пояснительная записка», ГОСТ 19.503-79 ЕСПД. «Руководство системного программиста», ГОСТ 19.504-79 ЕСПД. «Руководство программиста», ГОСТ 19.505-79 ЕСПД. «Руководство оператора» и т.п.

В частности, из Пояснительной записки можно взять схему алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений.

Основная часть документа должна состоять из вводной части и следующих разделов:

КАК работает ПРОЦЕССОР? ОБЪЯСНЯЕМ

· состав и функции.

В зависимости от особенностей программы допускается введение дополнительных разделов.

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

Например: Программа «Автоматизированное рабочее место разработчика САУ» предназначена для … реализована на …. Программа поддерживает …

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

Например: Программа предназначена для решения задач … Программа представляет собой ядро автоматизированного рабочего места …

Пользователь имеет возможность …, осуществить …, запустить …, проанализировать …, получить результаты анализа и обработки …, построить … и т.п.

В разделе » Описание логики » указывают:

-описание структуры программы и ее основных частей;

Например: В состав программы входят следующие компоненты:

· пользовательский интерфейс,

· модуль определения путей в графе,

· модуль расчета передаточной функции,

· модуль построения амплитудно- и фазочастотных характеристик,

· модуль построения реакции на полиномиальное воздействие,

· текстовый редактор).

-описание функций составных частей и связей между ними;

Например: Программа состоит из шести модулей: интерфейсный модуль; модуль определения …; модуль расчета …; модуль …и т.п.

Интерфейсный модуль построен на двух типах диалогов: диалог «вопрос — ответ» и диалог типа «меню». Интерфейсный модуль управляет …

Модуль определения … Он является …

Модуль расчета …и т.д.

-сведения о языке программирования;

Обучение работе на станках с ЧПУ. «С нуля» до первой детали

Например: Программа написана на языке …с использованием компилятора …

-описание входных и выходных данных для каждой из составных частей;

Например: ВХОДНЫЕ ДАННЫЕ. Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы.

ВЫХОДНЫЕ ДАННЫЕ. Выходными данными являются:

· выводимая на экран графическая и текстовая информация (результаты анализа системы);

· файлы в одном из графических форматов — копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);

· текстовые файлы — отчеты о проведенных исследованиях;

· диагностика состояния системы и сообщения о всех возникших ошибках.

-описание логики составных частей (при необходимости следует составлять описание схем программ). При описании логики программы необходима, естественно, привязка к тексту программы.

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

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

Например: Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа «мышь». Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на флоппи- и/или жестком дисках. Программа работает под управлением ОС …

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

Порядок вызова и загрузки системы.

Например: Загрузка программы осуществляется набором в командной строке DOS имени загрузочного модуля – SBM80N.EXE с возможным указанием имени файла данных.

Воспользуйтесь поиском по сайту:

studopedia.org — Студопедия.Орг — 2014-2023 год. Студопедия не является автором материалов, которые размещены. Но предоставляет возможность бесплатного использования (0.007 с) .

Источник: studopedia.org

Описание разработанного программного обеспечения

Разработанная в ходе дипломной работе программа предназначена для управления многоканальным измерительным преобразователем Ш9327 с помощью персонального компьютера из операционной среды Windows. Программа осуществляет постоянный контроль технологического процесса с целью удержания определенных параметров (температуры, давления и т.д.) в заданных интервалах. Программа также производит постоянный опрос оборудования на предмет обнаружения неисправностей и слежение за параметрами технологического процесса. Если проявляется неисправность или происходит существенное отклонение в ТП, то программа сигнализирует об этом загоранием соответствующего табло на панели инструментов и регистрирует неисправность/отклонение в базе соответствующей данных.

Структурная схема разработанного программного обеспечения

Рис. 2.1. Структурная схема разработанного ПО

Главная форма

MainForm — основная форма. Здесь расположены все средства управления программой. (Рис. 2.2).

Главная форма

Рис.2.2. Главная форма

На рис. 2.2 обозначены:

1. Текущая диагностика оборудования. Программа постоянно диагностирует оборудование и при обнаружении неполадки панель начинает сигнализировать (загорается красным цветом);

2. Текущая диагностика отклонений в техпроцессе. При обнаружении существенного отклонения панель начинает гореть красным цветом;

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

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

5. Кнопка дает возможность просмотреть текущую таблицу и архив команд оператора;

6. Открывает интерфейс Техническое состояние приборов;

7. Открывает интерфейс Показания и управление;

8. Открывает интерфейс Состояние релейных выходов);