Онлайн Радио 24 Описание программы обозначение что это
Описание программы (ГОСТ 19.402-78 [8] ) должно содержать:
1 Общие сведения о программе – полное наименование, обозначение, ее возможные применения, а также программное обеспечение, необходимое для функционирования программы, и языки программирования, на которых она написана. Например:
Программа “Автоматизированное рабочее место разработчика САУ” предназначена для… реализована на… Программа поддерживает…
Программа написана на языке…с использованием компилятора…
2 Функциональное назначение – назначение программы и общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы. Например:
Программа предназначена для решения задач… Программа представляет собой ядро автоматизированного рабочего места…
Пользователь имеет возможность…, осуществить…, запустить…, проанализировать…, получить результаты анализа и обработки…, построить… и т.п.
3 Описание логической структуры – используемые методы, алгоритмы программы, описание структуры и логики программы ( c привязкой к тексту программы на исходном языке) и ее составных частей, их функций и связей между ними, а также связи программы с другими программами. Содержание этого раздела должно быть конкретным и опираться на текст программы.
Выбор метода решения предполагает определение теоретической возможности решения задачи и нахождение формального правила его получения. Данный этап плохо формализуется, что связано с чрезвычайно широким многообразием задач и методов их решения.
Метод решения может быть представлен:
– в виде системы формул (безусловной или условной);
– в виде словесного изложения последовательности действий;
– в виде их комбинаций.
Описание метода может содержать ограничения на исходные данные, накладываемые методом.
Схемы алгоритмов, программ, данных и систем, приводимые в этом разделе, должны использовать метод пошаговой детализации. Причем уровень детализации должен быть таким, чтобы различные части программы и взаимосвязи между ними были понятны в целом. Другими словами сначала нужно описать обобщенную схему алгоритма, разбив программу логические блоки, а затем подробно рассмотреть схемы алгоритмов работы каждого из этих блоков. Условные обозначения и правила выполнения схем определяются ГОСТ 19.701-90 [10] (Приложение Б) .
В состав программы входят следующие модули:
– пользовательский интерфейс;
– модуль определения путей в графе;
– модуль расчета передаточной функции;
– модуль построения амплитудно- и фазочастотных характеристик;
– модуль построения реакции на полиномиальное воздействие;
– текстовый редактор.
Интерфейсный модуль построен на двух типах диалогов: диалог “вопрос – ответ” и диалог типа “меню”. Интерфейсный модуль управляет…
Модуль определения путей в графе основан на использовании метода… Он является…
Модуль расчета передаточной функции реализует метод… и т.д.
Алгоритм определения путей в графе имеет вид: …
4 Используемые технические средства – типы ЭВМ и устройств, используемых при работе программы. Например:
Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа “мышь”. Для поддержки графического режима необходим адаптер S VGA. Входные данные хранятся на гибком и/или жестком дисках. Программа работает под управлением ОС…
5 Вызов и загрузка – способ вызова программы с соответствующего носителя данных и входные точки в программу, а также имя загрузочного модуля, сведения об использовании оперативной памяти, объем программы и описание всей процедуры вызова и загрузки системы. Например:
Загрузка программы осуществляется набором в командной строке DOS имени загрузочного модуля – SBM80N.EXE с возможным указанием имени файла данных .
6 Входные данные – характер, организация и предварительная подготовка входных данных, их формат, описание и способ кодирования.
Описание структуры входных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.
В этом же разделе должно приводиться перечисление аномалий во входных данных (значения, для которых нельзя применять реализуемый метод решения) и реакций программы на них.
Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы. Этот файл имеет следующую структуру…
Используемый метод определения… не может быть использован при…, поэтому эти значения являются недопустимыми, а программа реагирует на них выводом сообщения…
7 Выходные данные – характер и организация выходных данных, их формат, описание и способ кодирования.
Описание структуры выходных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.
Выходными данными являются:
– выводимая на экран графическая и текстовая информация (результаты анализа системы);
– файлы в одном из графических форматов – копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);
– текстовые файлы – отчеты о проведенных исследованиях в формате… ;
– диагностика состояния системы и сообщения обо всех возникших ошибках.
В зависимости от особенностей программы допускается введение дополнительных разделов.
Содержание разделов допускается иллюстрировать пояснительными примерами, таблицами, схемами, графиками, примерами и т.п.
Описание программы (гост 19.402-78)
Этот стандарт ориентирован на документирование результирующего продукта разработки.
Строго говоря, существуют два разных документа, имеющих, правда, много общего. Это ОБЩЕЕ ОПИСАНИЕ (ГОСТ 19.502-78) и ОПИСАНИЕ ПРОГРАММЫ (ГОСТ 19.402-78). Однако, в силу того, что реально создать качественно и тот, и другой, не прибегая к почти полному дублированию, выдирая куски, весьма сложно, было бы достаточно реализовать один, более общий, “гибридный” документ. Назовем его “Описанием программы”.
На самом деле “Описание программы” в своей содержательной части может дополняться разделами и пунктами, взятыми и из стандартов для других описательных документов и руководств: ГОСТ 19.404-79 ЕСПД. Пояснительная записка, ГОСТ 19.503-79 ЕСПД. Руководство системного программиста, ГОСТ 19.504-79 ЕСПД. Руководство программиста, ГОСТ 19.505-79 ЕСПД. Руководство оператора и т.п. В частности, из Пояснительной записки можно взять схему алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений.
Описание программы обязательно должно включать информационную часть – аннотацию и содержание.
Основная часть документа должна состоять из вводной части и следующих разделов:
состав и функции.
В зависимости от особенностей программы допускается введение дополнительных разделов.
В Вводной части документа приводится информация общего характера о программе – полное наименование, обозначение, ее возможные применения и т.п.
Например: Программа “Автоматизированное рабочее место разработчика САУ” предназначена для … реализована на …. Программа поддерживает …
В разделе Назначение указывают назначение программы и приводят общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы, а также указывают типы электронных вычислительных машин и устройств, которые используются при работе.
Например: Программа предназначена для решения задач … Программа представляет собой ядро автоматизированного рабочего места …
Пользователь имеет возможность …, осуществить …, запустить …, проанализировать …, получить результаты анализа и обработки …, построить … и т.п.
В разделе “Описание логики” указывают:
описание структуры программы и ее основных частей
(например: В состав программы входит следующее:
пользовательский интерфейс,
модуль определения путей в графе,
модуль расчета передаточной функции,
модуль построения амплитудно- и фазочастотных характеристик,
модуль построения реакции на полиномиальное воздействие,
текстовый редактор).
описание функций составных частей и связей между ними;
Например: Программа состоит из шести модулей: интерфейсный модуль; модуль определения …; модуль расчета …; модуль …и т.п..
Интерфейсный модуль построен на двух типах диалогов: диалог “вопрос – ответ” и диалог типа “меню”. Интерфейсный модуль управляет …
Модуль определения … Он является …
Модуль расчета …и т.д.
сведения о языке программирования;
Например: Программа написана на языке …с использованием компилятора …
описание входных и выходных данных для каждой из составных частей;
Например: ВХОДНЫЕ ДАННЫЕ. Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы.
ВЫХОДНЫЕ ДАННЫЕ. Выходными данными являются:
выводимая на экран графическая и текстовая информация (результаты анализа системы);
файлы в одном из графических форматов – копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);
текстовые файлы – отчеты о проведенных исследованиях;
диагностика состояния системы и сообщения о всех возникших ошибках.
описание логики составных частей (при необходимости следует составлять описание схем программ). При описании логики программы необходима, естественно, привязка к тексту программы.
В разделе Состав и функции указывают описание состава и функции программ, применяемых методов решения задач.
В разделе Условия применения указываются условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.).
Например: Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа “мышь”. Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на флоппи- и/или жестком дисках. Программа работает под управлением ОС …
В приложение к описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.)
И не забудьте указать имя загрузочного модуля, а также описание всей процедуры
Вызова и загрузки системы
Например: Загрузка программы осуществляется набором в командной строке DOS имени загрузочного модуля – SBM80N.EXE с возможным указанием имени файла данных.
При подготовке материала использовались источники:
https://rguitp-pi.narod.ru/practice/opisanprogr.htm
https://studfile.net/preview/9852150/page:3/