Пример описание программы согласно гост 19.402 78. Курс молодого бойца: Об оформлении программной документации (документация)
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТЕдиная система программной документации | ГОСТ 19.402-78 |
ОПИСАНИЕ ПРОГРАММЫ | |
Unified system for program documentation. | |
Program description |
Дата введения 01.01.1980 |
Издание (январь 2010 г.) с Изменением №1, утвержденным в сентябре 1981 г. (ИУС 11-81).
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 дата введения установлена с 01.01.80
1. Настоящий стандарт устанавливает содержание и требования к содержанию программного документа "Описание программы", определенного ГОСТ 19.101-77 .
Стандарт полностью соответствует СТ СЭВ 2092-80 .
(Измененная редакция, Изм. № 1)
2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-79 .
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
4. В разделе "Общие сведения" должны быть указаны:
обозначение и наименование программы;
программное обеспечение, необходимое для функционирования программы;
языки программирования, на которых написана программа.
5. В разделе "Функциональное назначение" должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
6. В разделе "Описание логической структуры" должны быть указаны:
алгоритмы программы;
используемые методы;
структура программы с описанием функций составных частей и связи между ними;
связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
3-6. (Измененная редакция, Изм. № 1).
7. В разделе "Используемые технические средства" должны быть указаны типы электронных вычислительных машин и устройств, которые используются при работе программы.
способ вызова программы с соответствующего носителя данных;
входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
9. В разделе "Входные данные" должны быть указаны:
характер, организация и предварительная подготовка входных данных;
формат, описание и способ кодирования входных данных.
10. В разделе "Выходные данные" должны быть указаны:
характер и организация выходных данных;
формат, описание и способ кодирования выходных данных.
11. Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
12. В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.
7-12. (Введены дополнительно, Изм. № 1).
Это произведение не охраняется авторским правом.
В соответствии со статьёй 1259 Гражданского кодекса Российской Федерации не являются объектами авторских прав официальные документы государственных органов и органов местного самоуправления муниципальных образований, в том числе законы, другие нормативные акты, судебные решения, иные материалы законодательного, административного и судебного характера, официальные документы международных организаций, а также их официальные переводы, произведения народного творчества (фольклор), сообщения о событиях и фактах, имеющие исключительно информационный характер (сообщения о новостях дня, программы телепередач, расписания движения транспортных средств и тому подобное). |
Этот стандарт ориентирован на документирование результирующего продукта разработки.
Строго говоря, существуют два разных документа, имеющих, правда, много общего. Это ОБЩЕЕ ОПИСАНИЕ (ГОСТ 19.502-78) и ОПИСАНИЕ ПРОГРАММЫ (ГОСТ 19.402-78). Однако, в силу того, что реально создать качественно и тот, и другой, не прибегая к почти полному дублированию, выдирая куски, весьма сложно, было бы достаточно реализовать один, более общий, "гибридный" документ. Назовем его "Описанием программы".
На самом деле "Описание программы" в своей содержательной части может дополняться разделами и пунктами, взятыми и из стандартов для других описательных документов и руководств: ГОСТ 19.404-79 ЕСПД. Пояснительная записка, ГОСТ 19.503-79 ЕСПД. Руководство системного программиста, ГОСТ 19.504-79 ЕСПД. Руководство программиста, ГОСТ 19.505-79 ЕСПД. Руководство оператора и т.п. В частности, из Пояснительной записки можно взять схему алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений.
Описание программы обязательно должно включать информационную часть - аннотацию и содержание.
Основная часть документа должна состоять из вводной части и следующих разделов:
функциональное назначение;
описание логики.
условия применения;
состав и функции.
В зависимости от особенностей программы допускается введение дополнительных разделов.
В Вводной части документа приводится информация общего характера о программе - полное наименование, обозначение, ее возможные применения и т.п.
Например: Программа "Автоматизированное рабочее место разработчика САУ" предназначена для … реализована на …. Программа поддерживает …
В разделе Назначение указывают назначение программы и приводят общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы, а также указывают типы электронных вычислительных машин и устройств, которые используются при работе.
Например: Программа предназначена для решения задач … Программа представляет собой ядро автоматизированного рабочего места …
Пользователь имеет возможность …, осуществить …, запустить …, проанализировать …, получить результаты анализа и обработки …, построить … и т.п.
В разделе "Описание логики
" указывают:
описание структуры программы и ее основных частей (например: В состав программы входит следующее:
пользовательский интерфейс,
модуль определения путей в графе,
модуль расчета передаточной функции,
модуль построения амплитудно- и фазочастотных характеристик,
модуль построения реакции на полиномиальное воздействие,
текстовый редактор)
описание функций составных частей и связей между ними;
Например
: Программа состоит из шести модулей: интерфейсный модуль; модуль определения …; модуль расчета …; модуль …и т.п..
Интерфейсный модуль построен на двух типах диалогов: диалог "вопрос - ответ" и диалог типа "меню". Интерфейсный модуль управляет …
Модуль определения … Он является …
Модуль расчета …и т.д.
сведения о языке программирования;
Например
: Программа написана на языке …с использованием компилятора …
описание входных и выходных данных для каждой из составных частей;
Например: ВХОДНЫЕ ДАННЫЕ. Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы.
ВЫХОДНЫЕ ДАННЫЕ. Выходными данными являются:
· выводимая на экран графическая и текстовая информация (результаты анализа системы);
· файлы в одном из графических форматов - копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);
· текстовые файлы - отчеты о проведенных исследованиях;
· диагностика состояния системы и сообщения о всех возникших ошибках.
· описание логики составных частей (при необходимости следует составлять описание схем программ). При описании логики программы необходима, естественно, привязка к тексту программы.
В разделе Состав и функции указывают описание состава и функции программ, применяемых методов решения задач.
В разделе Условия применения указываются условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.).
Например: Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа "мышь". Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на флоппи- и/или жестком дисках. Программа работает под управлением ОС …
В приложение к описанию могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.)
И не забудьте указать имя загрузочного модуля, а также описание всей процедуры
Вызова и загрузки системы
Единая система программной документации
ОПИСАНИЕ ПРОГРАММЫ
Unified system for program documentation. Program description.
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен
с 01.01. 1980 г.
1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа «Описание программы», определённого ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2092-80.
2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
3. Описание программы должно содержать следующие разделы:
- общие сведения;
- функциональное назначение;
- описание логической структуры;
- используемые технические средства;
- входные данные;
- выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
4. В разделе «Общие сведения» должны быть указаны:
обозначение и наименование программы;
программное обеспечение, необходимое для функционирование программы;
языки программирования, на которых написана программа.
5. В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
6. В разделе «Описание логической структуры» должны быть указаны:
- алгоритм программы;
- используемые методы;
- структура программы с описанием функций составных частей и связи между ними;
- связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
3-6.(Измененная редакция, Изм. № 1).
7. В разделе «Используемые технические средства» должны быть указаны типы электронно-вычислительных машин и устройств, которые используются при работе программы.
- способ вызова программы с соответствующего носителя данных;
- входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
9. В разделе «Входные данные» должны быть указаны:
- характер, организация и предварительная подготовка входных данных;
- формат, описание и способ кодирования входных данных.
10. В разделе «Выходные данные» должны быть указаны:
- характер и организация выходных данных;
- формат, описание и способ кодирования выходных данных.
11. Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
12. В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.
7-12.(Введены дополнительно, Изм. № 1).
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Стандарт полностью соответствует СТ СЭВ 2092-80.
2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
3. Описание программы должно содержать следующие разделы:
входные данные;
выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
4. В разделе «Общие сведения» должны быть указаны:
обозначение и наименование программы;
используемые методы;
структура программы с описанием функций составных частей и связи между ними;
связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
3-6.(Измененная редакция, Изм. № 1).
7. В разделе «Используемые технические средства» должны быть указаны типы электронных вычислительных машин и устройств, которые используются при работе программы.
характер, организация и предварительная подготовка входных данных;
формат, описание и способ кодирования входных данных.
10. В разделе «Выходные данные» должны быть указаны:
характер и организация выходных данных;
формат, описание и способ кодирования выходных данных.
11. Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
12. В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.
7-12.(Введены дополнительно, Изм. № 1).
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
Единая система программной документации |
ГОСТ 19.402-78*(СТ СЭВ 2092-80) |
ОПИСАНИЕ ПРОГРАММЫ |
|
United system for program documentation. Program description |
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен
с 01.01. 1980 г.
1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа «Описание программы», определённого ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2092-80.
2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
3. Описание программы должно содержать следующие разделы:
общие сведения;
функциональное назначение;
описание логической структуры;
используемые технические средства;
входные данные;
выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
4. В разделе «Общие сведения» должны быть указаны:
обозначение и наименование программы;
программное обеспечение, необходимое для функционирование программы;
языки программирования, на которых написана программа.
5. В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
6. В разделе «Описание логической структуры» должны быть указаны:
алгоритм программы;
используемые методы;
структура программы с описанием функций составных частей и связи между ними;
связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
3-6.(Измененная редакция, Изм. № 1).
7. В разделе «Используемые технические средства» должны быть указаны типы электронно-вычислительных машин и устройств, которые используются при работе программы.
способ вызова программы с соответствующего носителя данных;
входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
9. В разделе «Входные данные» должны быть указаны:
характер, организация и предварительная подготовка входных данных;
формат, описание и способ кодирования входных данных.
10. В разделе «Выходные данные» должны быть указаны:
характер и организация выходных данных;
формат, описание и способ кодирования выходных данных.
11. Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
12. В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.
7-12.(Введены дополнительно, Изм. № 1).
* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)