Документ Стадии и этапы разработки выполняется в соответствии с требованиями ГОСТ 19.102-77 ЕСПД. «Стадии разработки», который устанавливает стадии разработки программ, программной документации, а также этапы и содержание работ:
| Стадии разработки | Этапы работ | Содержание работ |
| Техническое задание | Обоснование необходимости разработки программы | Постановка задачи. Сбор исходных материалов. Выбор и обоснование критериев эффективности и качества разрабатываемой программы. Обоснование необходимости проведения научно-исследовательских работ. |
| Научно-исследователь-ские работы | Определение структуры входных и выходных данных. Предварительный выбор методов решения задач. Обоснование целесообразности применения ранее разработанных программ. Определение требований к техническим средствам. Обоснование принципиальной возможности решения поставленной задачи. | |
| Разработка и утверждение технического задания | Определение требований к программе. Разработка технико-экономического обоснования разработки программы. Определение стадий, этапов и сроков разработки программы и документации на нее. Выбор языков программирования. Определение необходимости проведения научно-исследовательских работ на последующих стадиях. Согласование и утверждение технического задания. | |
| Эскизный проект | Разработка эскизного проекта | Предварительная разработка структуры входных и выходных данных. Уточнение методов решения задачи. Разработка общего описания алгоритма решения задачи. Разработка технико-экономического обоснования. |
| Утверждение эскизного проекта | Разработка пояснительной записки. Согласование и утверждение эскизного проекта | |
| Технический проект | Разработка технического проекта | Уточнение структуры входных и выходных данных. Разработка алгоритма решения задачи. Определение формы представления входных и выходных данных. Определение семантики и синтаксиса языка. Разработка структуры программы. Окончательное определение конфигурации технических средств. |
| Утверждение технического проекта | Разработка плана мероприятий по разработке и внедрению программ. Разработка пояснительной записки. Согласование и утверждение технического проекта. | |
| Рабочий проект | Разработка программы | Программирование и отладка программы |
| Разработка программной документации | Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77. | |
| Испытания программы | Разработка, согласование и утверждение программы и методики испытаний. Проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний. Корректировка программы и программной документации по результатам испытаний. | |
| Внедрение | Подготовка и передача программы | Подготовка и передача программы и программной документации для сопровождения и (или) изготовления. Оформление и утверждение акта о передаче программы на сопровождение и (или) изготовление. Передача программы в фонд алгоритмов и программ. |
Примечания:
1. Допускается исключать вторую стадию разработки (эскизный проект), а в технически обоснованных случаях — вторую и третью стадии (эскизный и технический проекты). Необходимость проведения этих стадий указывается в техническом задании.
2. Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с заказчиком.
Описание программы
Документ Описание программыориентирован на документальное описание результирующего продукта разработки.
Этот документ создан на базе двух разных стандартов: ГОСТ 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 с возможным указанием имени файла данных.
Текст программы
Документ Текст программывыполняется в соответствии с требованиями ГОСТ 19.401-78 ЕСПД. «Текст программы. Требования к содержанию и оформлению», который устанавливает правила составления текста программы и его оформления.
Требования к оформлению текста программы достаточно просты. Основное, чем необходимо руководствоваться при создании этого документа – это то, что текст программы должен быть удобочитаемым.
Обязательным является составление информационной части – аннотации и содержания.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
Текст каждого программного файла начинается с шапки, в которой указывается:
- наименование программы,
- автор,
- дата создания программы,
- номер версии,
- дата последней модификации.
Обязательными являются комментарии, а также строгое соблюдение правил отступа. Неудобочитаемый текст программы, который понятен только самому автору, говорит о его невысокой компьютерной грамотности. Тексты программ должно быть не стыдно давать читать другим людям.
