Описание программы (ГОСТ 19.402-78 ) должно содержать:

1 Общие сведения о программе – полное наименование, обозначение, ее возможные применения, а также программное обеспечение, необходимое для функционирования программы, и языки программирования, на которых она написана. Например:

Программа "Автоматизированное рабочее место разработчика САУ" предназначена для… реализована на… Программа поддерживает…

Программа написана на языке…с использованием компилятора…

2 Функциональное назначение – назначение программы и общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы. Например:

Программа предназначена для решения задач… Программа представляет собой ядро автоматизированного рабочего места…

Пользователь имеет возможность…, осуществить…, запустить…, проанализировать…, получить результаты анализа и обработки…, построить… и т.п.

3 Описание логической структуры – используемые методы, алгоритмы программы, описание структуры и логики программы (c привязкой к тексту программы на исходном языке) и ее составных частей, их функций и связей между ними, а также связи программы с другими программами. Содержание этого раздела должно быть конкретным и опираться на текст программы.

Выбор метода решения предполагает определение теоретической возможности решения задачи и нахождение формального правила его получения. Данный этап плохо формализуется, что связано с чрезвычайно широким многообразием задач и методов их решения.

Метод решения может быть представлен:

– в виде системы формул (безусловной или условной);

– в виде словесного изложения последовательности действий;

– в виде их комбинаций.

Описание метода может содержать ограничения на исходные данные, накладываемые методом.

Схемы алгоритмов, программ, данных и систем , приводимые в этом разделе, должны использовать метод пошаговой детализации. Причем уровень детализации должен быть таким, чтобы различные части программы и взаимосвязи между ними были понятны в целом. Другими словами сначала нужно описать обобщенную схему алгоритма, разбив программу логические блоки, а затем подробно рассмотреть схемы алгоритмов работы каждого из этих блоков. Условные обозначения и правила выполнения схем определяются ГОСТ 19.701-90 (Приложение Б) .

В состав программы входят следующие модули:

– пользовательский интерфейс;

– модуль определения путей в графе;

– модуль расчета передаточной функции;

– модуль построения амплитудно- и фазочастотных характеристик;

– модуль построения реакции на полиномиальное воздействие;

– текстовый редактор.

Интерфейсный модуль построен на двух типах диалогов: диалог "вопрос – ответ" и диалог типа "меню". Интерфейсный модуль управляет…

Модуль определения путей в графе основан на использовании метода… Он является…

Модуль расчета передаточной функции реализует метод… и т.д.

Алгоритм определения путей в графе имеет вид: …

4 Используемые технические средства – типы ЭВМ и устройств, используемых при работе программы. Например:

Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа "мышь". Для поддержки графического режима необходим адаптер S VGA. Входные данные хранятся на гибком и/или жестком дисках. Программа работает под управлением ОС…

– способ вызова программы с соответствующего носителя данных и входные точки в программу, а также имя загрузочного модуля, сведения об использовании оперативной памяти, объем программы и описание всей процедуры вызова и загрузки системы. Например:

6 Входные данные – характер, организация и предварительная подготовка входных данных, их формат, описание и способ кодирования.

Описание структуры входных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.

В этом же разделе должно приводиться перечисление аномалий во входных данных (значения, для которых нельзя применять реализуемый метод решения) и реакций программы на них.

Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы. Этот файл имеет следующую структуру…

Используемый метод определения… не может быть использован при…, поэтому эти значения являются недопустимыми, а программа реагирует на них выводом сообщения…

7 Выходные данные – характер и организация выходных данных, их формат, описание и способ кодирования.

Описание структуры выходных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.

Выходными данными являются:

– выводимая на экран графическая и текстовая информация (результаты анализа системы);

– файлы в одном из графических форматов – копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);

– текстовые файлы – отчеты о проведенных исследованиях в формате… ;

– диагностика состояния системы и сообщения обо всех возникших ошибках.

В зависимости от особенностей программы допускается введение дополнительных разделов.

Данный документ относится к типу программно-эксплуатационной. Применяется к программе, комплексу, ПАК, программному компоненту или системе.
Целевая аудитория: лица, которые принимают решение о покупке и вводе в эксплуатацию программы. Документ содержит информацию о функциональных возможностях программы и сфере её применения.

ГОСТы и стандарты

Структуру и оформление документа определяется в .
Информационная часть (аннотации и содержания) в соответствии с .

В каких случаях необходим

Документ необходим для информирования потенциальных пользователей и покупателей о назначении программы и способах применения. Больше подходит для менеджеров (специалистов, системных администраторов), которые самостоятельно принимают решение о приобретении программы и вводе её в эксплуатацию.

Всю необходимую информацию они смогут получить из этого документа: описание программы и ее применение.

В описании программы и описании применения указываются:

Задачи, которые решает программа;
Затрачиваемые ресурсы для работы;
Вводная информация;
Выходные данные.

Акцент делается на описательной части программы, её функциях и назначении. В меньшей степени на описании применения. Делается описание именно о возможностях программы и задач, которая она решает, а не её внутреннего устройства. При определённых особенностях программы допускается объединять разделы или вводить новые (дополнительные).

Структура описания программы (ГОСТ 19.402-78):

1. Общие сведения.
2. Функциональное назначение программы.
3. Описание логической структуры.
4. Технические средства, которые используются.
5. Вызов и загрузка.
6. Входные данные.
7. Выходные данные.

Структура описания применения (ГОСТ 19.502-78):

1. Назначение программы.
2. Условия применения.
3. Описательная часть задачи.
4. Входные и выходные данные.
5. приложения (таблицы, иллюстрации и т.д.).

Вы можете заказать разработку документа или полного комплекта документации на программное обеспечение.

Постановлением Государственного комитета СССР по стандартам от 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)

Общие сведения.

Программа называется jane и сохранена в файле jane.dpr. Программа использует вспомогательные модули main, new, dmData, about, сохранённые соответственно в файлах main.pas, new.pas, about.pas, dmData.pas. Программа написана на языке программирования Delphi. Программа использует данные из таблиц базы данных otdel.db, sotrudnik.db, family.db, obrazovanie.db

Функциональное назначение.

Реализация графа диалога.

Обычно интерфейс между пользователем и компьютером включает экран монитора клавиатуру и мышь это то, что представляет информацию для пользователя и принимает информацию от него. ,

Практически программа, написанная с помощью Delphi доступна через графический пользовательский интерфейс. Графический интерфейс, осуществляемый прикладной программой это своеобразный диалог, который происходит между компьютером и его пользователем. Другими словами интерфейс это та часть программы, которая для выполнения некоторых функций переводит действия пользователя в один или более запросов и обеспечивает обратную связь с пользователем в соответствии с последовательностью его действий.

Пользователь имеет возможность выбора функций системы, применяя кнопочное и пиктографическое меню. Пользователь видит перед собой содержимое базы данных в виде экранного документа. Взаимодействие с пользователем осуществляется посредством экранных форм. Реализация графа диалога показана на рисунке 17.

Рисунок 17. Дерево экранных форм

Описание логической структуры.

Программа управляется событийно. При нажатии на какую-либо кнопку в программу поступает сообщение, при этом вызывается соответствующая процедура-обработчик, которая обрабатывает данное событие. Результаты обработки можно видеть на экране монитора. Например: при нажатии на кнопку “Работа” в форме “Дипломный проект” вызывается процедура, содержащаяся в модуле New, которая скрывает форму “Дипломный проект”, выводит на экран монитора форму “Кадровый учет”, при этом управление передается модулю Main.

Для выполнения программы необходимо загрузить на персональном компьютере программную оболочку Delphi, откомпилировать исходный текст программы, содержащийся в файле jane.dpr. Вызвать exe файл и далее работать с ним. Перед началом работы необходимо пройти процедуру авторизации (рисунок 18).

Рисунок 18. Форма Ввод пароля

Входные и выходные данные.

Входные данные:

название отдела,

ФИО начальника,

ФИО сотрудников, должность,

дата приема на работу,

место последней работы,

стаж на дату приема,

признак наличия образования,

признак наличия семьи,

количество детей,

семейное положение,

даты рождения,

тип образования,

форма обучения,

учебное заведение,

дата окончания,

специальность.

Выходные данные: все результаты действий пользователя в работе с базами данных отображаются на экране монитора; эти результаты, выведенные в виде базы данных на экран, являются выходными данными для программы. Также результатом работы с базой данный «Кадровый учет» может быть формирование приказов и вывод их на печать, что значительно облегчает работу пользователя и избавляет от необходимости составлять в ручную в каком-либо текстовом редакторе такие документы как приказ об увольнении или принятии на работу сотрудников и их личных карточек.

ГОСТ 19.101-77 определяет описание программы как совокупность сведений о логической структуре и функционировании программы. Описание программы должно состоять из четырех основных частей: титульной части, информационной части, основной части, части регистрации изменений.

Основная часть должна содержать следующие разделы: общие сведения, функциональное назначение, описание логической структуры, используемые технические средства, вызов и загрузка, входные данные, выходные данные.

В зависимости от особенностей программы допускается вводить новые разделы или объединять отдельные разделы. При описании программного продукта, содержащего несколько программных единиц (программ, подпрограмм), описание по указанной схеме дают для каждой программной единицы, придерживаясь при этом иерархии компоновки общего программного продукта. Так, например, если общая программа Control включает обращение к функции FileExist и процедуре Brackets, которая в свою очередь обращается к процедуре Error, и общая схема иерархии данного программного продукта изображена на рисунке 6, то описание необходимо начинать с программной единицы Control далее описывать программные единицы FileExist, Brackets, Stack, затем описать программную единицу Error в составе Brackets

Пример иерархии сложного программного продукта приведен на рисунке 6.

Программа контроля

расстановки скобок

в программах

Brackets FileExist Stack

Процедура проверки Функция проверки Модуль

правильности существования для работы

расстановки скобок файла со стеком

Процедура InitStack EmptyStack InStack OutStack

Расшифровки Процедура Функция Процедура Процедура

ошибок инициализации проверки включения извлечения

стека пустоты стека элемента элемента

в стек из стека

Рисунок 6 – Структурная диаграмма программы

В разделе "Общие сведения" указываются обозначение и наименование программы, программное обеспечение (операционная среда, прикладные программы), необходимое для функционирования описываемой программы. Если для различных режимов обработки требуются разные прикладные программы, следует дать таблицу, которая показывает, какое программное обеспечение требуется для каждого режима. Необходимо указать язык программирования, на котором написана программа.

В разделе "Функциональное назначение" определяется класс решаемых задач и (или) назначение программы. В этом пункте следует четко перечислить все функции, которые программа выполняет в установленном порядке или по выбору пользователя. Необходимо указать ограничения на применение программы.

В разделе "Описание логической структуры" приводится структурная диаграмма программы, в которой указываются имена и назначение составляющих модулей и подпрограмм (рисунок 6). Словесное описание структурных единиц программы сопровождается представлением укрупненных схем алгоритмов, в целом, не более трех листов. На первом листе приводится укрупненная схема алгоритма функционирования главной программы. Кроме этого, представляются схемы алгоритмов тех подпрограмм, которые отображают суть метода решения задачи. Примеры схем алгоритмов приведены на рисунках 7, 8, 9, 10.

Оформление схем алгоритмов должно соответствовать требованиям ГОСТ 19.701-90 "Схемы алгоритмов, программ, данных и систем". Первым блоком в любой схеме является блок ПУСК (или НАЧАЛО):

Соединительные линии в схеме, называемые иначе линиями потока, не должны пересекаться, для этого применяются внутристраничные соединители

и межстраничные соединители

12 [ с листа...

12 [ на лист…

Стрелка, направленная к соединителю, означает, что управление передается блоку, номер которого указан внутри соединителя. Стрелка, направленная от соединителя, означает, что управление передается от блока, номер которого указан внутри соединителя. Каждая схема алгоритма для отдельной программной единицы изображается на отдельном рисунке. Рисунки нумеруются подряд внутри одного документа. Каждый рисунок имеет название, которое пишется над рисунком, и номер, который пишется под рисунком. Названием рисунка с изображением схемы алгоритма может служить наименование соответствующей программной единицы, например: "Схема алгоритма программы контроля" или "Схема алгоритма подпрограммы Error". Примеры схем алгоритмов приведены на рисунках 7, 8, 9, 10.

Рисунок 8 - Функция FileExist Рисунок 9 - Процедура Error

Рисунок 10 – Схема алгоритма процедуры Brackets

При сопровождении программного средства описание логической структуры является материалом, по которому находится та часть текста программы, которую нужно модифицировать или модернизировать. При описании логики работы программы в соответствии с приводимой схемой алгоритма необходимо описать работу, выполняемую каждым блоком.

В разделе "Используемые технические средства" необходимо указать типы ЭВМ, конфигурацию вычислительного комплекса, для которого разработано описываемое программное средство. Если программа учитывает особенности операционной среды, то следует указать ту операционную среду, в которой работает эта программа.

указывается способ вызова программы с соответствующего носителя данных и входные параметры при запуске программы. Допускается указывать объем программы, сведения об использовании оперативной и внешней памяти. Необходимо указать, как фактически начинается выполнение программы, какие сообщения ожидаются в течение этого начального периода.

В разделе "Входные данные" необходимо указать характер, организацию и предварительную подготовку входных данных. Необходимо описать все типы входных данных, назначение каждого типа. Если входная информация может быть представлена последовательностью некоторых крупных логических единиц, то необходимо описать способы объединения входных данных в эти более крупные логические единицы. Необходимо указать формат и назначение всех полей логической записи данных. Необходимо указать также ограничения на размеры и количество входных данных. Выходные данные описываются с той же степенью подробности, что и входные. Если выходными данными являются одно или несколько сообщений, то необходимо указать, как пользователь должен интерпретировать каждое сообщение, как он может использовать информацию, содержащуюся в каждом сообщении.