Описание программы (ГОСТ 19.402-78 ) должно содержать:
1 Общие сведения о программе – полное наименование, обозначение, ее возможные применения, а также программное обеспечение, необходимое для функционирования программы, и языки программирования, на которых она написана. Например:
Программа «Автоматизированное рабочее место разработчика САУ» предназначена для… реализована на… Программа поддерживает…
Программа написана на языке…с использованием компилятора…
2 Функциональное назначение – назначение программы и общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы. Например:
Программа предназначена для решения задач… Программа представляет собой ядро автоматизированного рабочего места…
Пользователь имеет возможность…, осуществить…, запустить…, проанализировать…, получить результаты анализа и обработки…, построить… и т.п.
3 Описание логической структуры – используемые методы, алгоритмы программы, описание структуры и логики программы (c привязкой к тексту программы на исходном языке) и ее составных частей, их функций и связей между ними, а также связи программы с другими программами. Содержание этого раздела должно быть конкретным и опираться на текст программы.
Как научиться читать чертеж? Чтение чертежа для начинающих
Выбор метода решения предполагает определение теоретической возможности решения задачи и нахождение формального правила его получения. Данный этап плохо формализуется, что связано с чрезвычайно широким многообразием задач и методов их решения.
Метод решения может быть представлен:
– в виде системы формул (безусловной или условной);
– в виде словесного изложения последовательности действий;
– в виде их комбинаций.
Описание метода может содержать ограничения на исходные данные, накладываемые методом.
Схемы алгоритмов, программ, данных и систем , приводимые в этом разделе, должны использовать метод пошаговой детализации. Причем уровень детализации должен быть таким, чтобы различные части программы и взаимосвязи между ними были понятны в целом. Другими словами сначала нужно описать обобщенную схему алгоритма, разбив программу логические блоки, а затем подробно рассмотреть схемы алгоритмов работы каждого из этих блоков. Условные обозначения и правила выполнения схем определяются ГОСТ 19.701-90 (Приложение Б) .
В состав программы входят следующие модули:
– пользовательский интерфейс;
– модуль определения путей в графе;
– модуль расчета передаточной функции;
– модуль построения амплитудно- и фазочастотных характеристик;
– модуль построения реакции на полиномиальное воздействие;
– текстовый редактор.
Интерфейсный модуль построен на двух типах диалогов: диалог «вопрос – ответ» и диалог типа «меню». Интерфейсный модуль управляет…
Модуль определения путей в графе основан на использовании метода… Он является…
Модуль расчета передаточной функции реализует метод… и т.д.
API для начинающих. Пример VK. [1/5]
Алгоритм определения путей в графе имеет вид: …
4 Используемые технические средства – типы ЭВМ и устройств, используемых при работе программы. Например:
Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа «мышь». Для поддержки графического режима необходим адаптер S VGA. Входные данные хранятся на гибком и/или жестком дисках. Программа работает под управлением ОС…
– способ вызова программы с соответствующего носителя данных и входные точки в программу, а также имя загрузочного модуля, сведения об использовании оперативной памяти, объем программы и описание всей процедуры вызова и загрузки системы. Например:
6 Входные данные – характер, организация и предварительная подготовка входных данных, их формат, описание и способ кодирования.
Описание структуры входных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.
В этом же разделе должно приводиться перечисление аномалий во входных данных (значения, для которых нельзя применять реализуемый метод решения) и реакций программы на них.
Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы. Этот файл имеет следующую структуру…
Используемый метод определения… не может быть использован при…, поэтому эти значения являются недопустимыми, а программа реагирует на них выводом сообщения…
7 Выходные данные – характер и организация выходных данных, их формат, описание и способ кодирования.
Описание структуры выходных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.
Выходными данными являются:
– выводимая на экран графическая и текстовая информация (результаты анализа системы);
– файлы в одном из графических форматов – копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);
– текстовые файлы – отчеты о проведенных исследованиях в формате… ;
– диагностика состояния системы и сообщения обо всех возникших ошибках.
В зависимости от особенностей программы допускается введение дополнительных разделов.
Краткий алгоритм оформления программы
Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.
Оформление программного документа
Программный документ — документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77 , ГОСТ 19.103-77 , ГОСТ 19.104-78 , ГОСТ 19.105-78 , ГОСТ 19.106-78 , ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.
Общие требования к программным документам. ГОСТ 19.105 — 78
Требования к программным документам, выполненным печатным способом. ГОСТ 19.106 — 78
ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.
Важно отметить, что данный ГОСТ не распространяется на программный документ «Текст программы».
Материалы программного документа должны располагаться в следующей последовательности :
- Титульная часть:
- лист утверждения (не входит в общее количество листов документа);
- титульный лист (первый лист документа);
- аннотация;
- лист содержания;
- текст документа (с рисунками, таблицами и т.п.);
- приложения;
- перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
- часть регистрации изменений:
- лист регистрации изменений.
- Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
- Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
- Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
- Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
- Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
- Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
- при выполнении документа машинописным способом — двум интервалам.
- при выполнении документа машинописным способом — трём машинописным интервалам.
В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.
ГОСТ 19.502-78 Единая система программной документации. Описание применения. Требования к содержанию и оформлению
Текст ГОСТ 19.502-78 Единая система программной документации. Описание применения. Требования к содержанию и оформлению
ГОСУДАРСТВЕННЫЙСТАНДАРТ СОЮЗА ССР
ЕДИНАЯ СИСТЕМА
ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
ОБЩЕЕОПИСАНИЕ.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ
ГОСТ 19.502-78*
ГОСУДАРСТВЕННЫЙСТАНДАРТ СОЮЗА ССР
Единая система программной документации
ОПИСАНИЕ ПРИМЕНЕНИЯ.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ
Unified System for Program Documentation.
Description of use.
Requirements to contents and form of presentation
Постановлением Государственного комитета СССР по стандартам от 18декабря 1978 г. № 3350 срок введения установлен
1. Настоящий стандарт устанавливает состав и требования к содержанию программногодокумента «Общее описание», определенного ГОСТ 19.101-77.
Стандарт полностьсоответствует СТ СЭВ 2093-80.
2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационнойчасти (аннотации и содержания) является обязательным.
3. Текст документа должен состоять из следующих разделов:
входные и выходные данные.
4. В зависимости отособенностей программы допускается вводить дополнительные разделы илиобъединять отдельные разделы.
3.4.(Измененная редакция, Изм. № 1).
5. В разделе «Назначение программы» указывают назначение, возможностипрограммы, ее основные характеристики, ограничения, накладываемые на областьприменения программы.
6. В разделе «Условия применения» указывают условия, необходимые длявыполнения программы (требования к необходимым для данной программы техническимсредствам, и другим программам, общие характеристики входной и выходнойинформации, а также требования и условия организационного, технического итехнологического характера и т.п.).
7. В разделе «Описание задачи» должны быть указаны определения задачи иметоды ее решения.
(Измененная редакция, Изм. №1).
7а. В разделе «Входные ивыходные данные» должны быть указаны сведения о входных и выходных данных.
(Введен дополнительно, Изм.№ 1).
8. В приложение к общему описанию могут быть включены справочныематериалы (иллюстрации, таблицы, графики, примеры и т.п.).
allgosts.ru
Превью ГОСТ 19.502-78 Единая система программной документации. Описание применения. Требования к содержанию и оформлению
Источник: allgosts.ru
Описание применения программы пример документа
Все документы, представленные в каталоге, не являются их официальным изданием и предназначены исключительно для ознакомительных целей. Электронные копии этих документов могут распространяться без всяких ограничений. Вы можете размещать информацию с этого сайта на любом другом сайте.
ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР
ЕДИНАЯ СИСТЕМА
ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
ОБЩЕЕ ОПИСАНИЕ.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ
ГОСТ 19.502-78*
ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР
ОПИСАНИЕ ПРИМЕНЕНИЯ.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ
Unified System for Program Documentation.
Description of use.
Requirements to contents and form of presentation
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен
с 01.01.1980 г.
1 . Настоящий стандарт устанавливает состав и требования к содержанию программного документа «Общее описание», определенного ГОСТ 19.101-77 .
2 . Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78 .
Составление информационной части (аннотации и содержания) является обязательным.
3 . Текст документа должен состоять из следующих разделов:
входные и выходные данные.
4. В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
5 . В разделе «Назначение программы» указывают назначение, возможности программы, ее основные характеристики, ограничения, накладываемые на область применения программы.
6 . В разделе «Условия применения» указывают условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.).
7 . В разделе «Описание задачи» должны быть указаны определения задачи и методы ее решения .
(Измененная редакция, Изм. № 1).
7а. В разделе «Входные и выходные данные» должны быть указаны сведения о входных и выходных данных.
(Введен дополнительно, Изм. № 1).
8 . В приложение к общему описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.).
Источник: www.infosait.ru