ГОСТ 19.101-77 (Виды программ и программных продуктов)
ГОСТ 19.103-77 (Обозначение программ и программных документов)
ГОСТ 19.104-78 (Основные надписи)
ГОСТ 19.105-78 (Общие требования к программным документам)
ГОСТ 19.106-78 (Общие требования к программным документам, выполненным печатным способом)
ГОСТ 19.604-78 (Правила внесения изменений в прогаммные документы, выполненные печатным способом)
Описание программы (ГОСТ 19.402.78)
Оно ориентированно на документирование результирующего продукта разработки. В пояснительную записку можно взять схему алгоритма, общее описание функционирование программы, обоснование принятых технических и технико-экономических решений.
Описание программы должно обязательно включать информационную часть, аннатацию и содержание.
Основная часть документа состоит из
- водной части
- раздел Функциональное назначение;
- раздел Описание логики;
- раздел Условное применение;
- раздел Состав и функции.
Пример
В вводной части
Программа «Автоматизированное рабочее место…» предназначена для …. Реализована на …
Программа поддерживает …
В разделе назначение
Программа предназначена для решения задач…
Программа представляет собой ядро автоматизированного рабочего места…
Пользователь имеет возможность …
Осуществить…
Запустить…
Проанализировать…
Получить результаты анализа и обработки…
Построить ….
В разделе описание логики указывают
Описание структуры программы и ее составных частей
В состав программы входит следующее:
- Пользовательский интерфейс,
- Модуль определения путей в графе,
- Модуль расчета передаточной функции,
- Модуль построения амплитудно и фазочастотных характеристик,
- Модуль построения реакции на полиномиальное воздействие,
- Текстовый редактор.
Описание функций составных частей и связей между ними
Программа состоит из …. модулей:
- Интерфейсный модуль
- Модуль определения
- Модуль расчета
- Модуль…
Интерфейсный модуль построен на двух типах диалогов:
1. диалог «вопрос-ответ»
2. диалог типа меню.
Выходные данные
Выходными данными является:
1. выводимая на экран графическая и текстовая информация (результаты анализа системы);
2. файлы в одном из графическом формате – копии изображения построенных характеристик.
3. Текстовые файлы – отчеты о проведенных исследованиях.
4. Диагностика состояния системы и сообщения о всех возникающих ошибках.
5. Описание логики составных частей (при необходимости следует составлять описание схем программ).
В разделе Условия применения
Указываются условия, необходимые для выполнения программы (требования к необходимости для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.)
Программа эксплуатируется на ПК IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа «мышь». Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на флэш и ил жестком диске. Программа работает под управлением ОС…
Необходимо указать имя загрузочного модуля, а также всей процедуры вызова и загрузки системы.
Загрузка программы осуществляется набором в командной строке .DOS имени загрузочного модуля – SSXX/EXE. С возможным указанием имени файла данных.
В разделе состав и функции
Указывают описание состава и функции программ, применяемых методов решения задачи.
Текст программы(ГОСТ 19.401-78)
Требования к оформлению текста программы достаточно просты и естественны для грамотного программиста. Основное чем требуется руководствоваться при создании этого доку4мента – это, то что текст программы должен быть удобочитаемым.
Обязательным является составление информационной части – аннотации и содержания.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
Текст каждого программного файла начинается с «шапки», в которой указывается:
- Наименование программы;
- Автор;
- Дата создания программы;
- Номер версии;
- Дата последней модификации.
Обязательными являются комментарии, а также строгое соблюдение правил отступа.
Программа методики испытаний (ГОСТ 19.301-79)
В этом документе содержится описание того, что и как необходимо сделать, дабы убедиться (и убедить заказчика) в правильности работы программы. Документ содержит описание объекта и цели испытаний, требования к программе и к программной документации, средства и порядок испытаний., а также описание тестовых примеров.
Составные части этого документа:
1. Объект испытаний
Пример
Объектом испытаний является программа предназначенная для …
2. Цель испытаний
Пример
Проверка надежности испытания программы.
3. Требования к программе
Пример
Функционирование программы не должно приводить к сбою. Организация диалога должна предусматривать защиту от ввода некорректных данных. Программа должна выводить диагностику состояния системы и сообщения о любых возникших ошибках … и т.п.
4. Требования к программной документации
Пример
Состав программной документации, представляемой на испытания: описание программы (ГОСТ 19.402-78), программа методики испытаний (ГОСТ 19.301-79), текст программы (ГОСТ 19.401-78).
5. Средства и порядок испытаний
Пример
Программа работает в соответствии с условиями эксплуатации ОС MSDOS (версия не ниже 3.0) на ПК типа IBM PC/AT, а также на совместимых с ним. Для работы необходим также адаптер EGA (VGA).
Порядок проведения испытаний:
Запуск программы осуществляется …
Выбирается …
Нажимается …
Последовательно выбираются …
6. Тестовые примеры
Пример
Для проведения испытаний предлагаются …, описание которых содержится в файлах … Содержимое тестовых файлов и результаты работы программы приведены в Приложении №1.
Требования к программным документам, выполненным печатным способом (ГОСТ 19.106-78)
Этот стандарт устанавливает правила выполнения программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами ЕСПД.
Общие требования:
Дополнительные слова писать от руки чертежным шрифтом. Повреждение листов, помарки и следы не допускаются. Программные документы оформляются на листах формата А4, допустимо на листах А3. При изготовлении документа типографским способом возможно использование листов типографских форматов.
Последовательность.
1. Титульная часть.
2. Лист утверждение (не входит в общее количество)
3. Титульный лист (первый лист документа)
4. Информационная часть.
5. Аннотация.
6. Лист содержания.
7. Основная часть.
8. Текст документа (с рисунками, таблицами и т.п.).
