ГОСТ 19.402-78
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
ОПИСАНИЕ ПРОГРАММЫ
Unified system for program documentation. Program description.
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета CCCР по стандартам от 18 декабря 1978 г. N 3350 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).
1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа "Описание программы", определенного ГОСТ 19.101-77 .
Стандарт полностью соответствует СТ СЭВ 2092-80*.
________________
* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей . - Примечание изготовителя базы данных.
(Измененная редакция, Изм. N 1).
2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78 .
Составление информационной части (аннотации и содержания) является обязательным.
3. Описание программы должно содержать следующие разделы:
общие сведения;
функциональное назначение;
описание логической структуры;
используемые технические средства;
входные данные;
выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
4. В разделе "Общие сведения" должны быть указаны:
обозначение и наименование программы;
программное обеспечение, необходимое для функционирования программы;
языки программирования, на которых написана программа.
5. В разделе "Функциональное назначение" должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
6. В разделе "Описание логической структуры" должны быть указаны:
алгоритм программы;
используемые методы;
структура программы с описанием функций составных частей и связи между ними;
связи программы с другими программами.
Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
3-6. (Измененная редакция, Изм. N 1).
7. В разделе "Используемые технические средства" должны быть указаны типы электронных вычислительных машин и устройств, которые используются при работе программы.
способ вызова программы с соответствующего носителя данных;
входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
9. В разделе "Входные данные" должны быть указаны:
характер, организация и предварительная подготовка входных данных;
формат, описание и способ кодирования входных данных.
10. В разделе "Выходные данные" должны быть указаны:
характер и организация выходных данных;
формат, описание и способ кодирования выходных данных.
11. Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
12. В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.
7-12. (Введены дополнительно, Изм. N 1).
Электронный текст документа
подготовлен АО "Кодекс" и сверен по:
официальное издание
Единая система программной документации:
Сборник национальных стандартов. -
М.: Стандартинформ, 2010
Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД) . ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
Краткий алгоритм оформления программы
Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.
Оформление программного документа
Программный документ - документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 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 устанавливает правила выполнения программных документов для печатного способа выполнения.
Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".
Материалы программного документа должны располагаться в следующей последовательности :
- Титульная часть:
- лист утверждения (не входит в общее количество листов документа);
- титульный лист (первый лист документа);
- Информационная часть:
- аннотация;
- лист содержания;
- Основная часть:
- текст документа (с рисунками, таблицами и т.п.);
- приложения;
- перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
- часть регистрации изменений:
- лист регистрации изменений.
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
Форматирование текста:
- Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
- Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
- Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
- Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
- Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
- Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
- при выполнении документа машинописным способом - двум интервалам.
- Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
- при выполнении документа машинописным способом - трём машинописным интервалам.
- Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
- В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
- Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
- При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
- Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
- Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
- Необходимые пояснения к тексту документа могут оформляться сносками.
- Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
- Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
- Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
- Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
- Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
- В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
- Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
- В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
- Одно примечание не нумеруется. После слова «Примечание» ставят точку.
- Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
- Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
- Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
- Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.
В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.
Общие сведения.
Программа называется 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. Форма Ввод пароля
Входные и выходные данные.
Входные данные:
название отдела,
ФИО начальника,
ФИО сотрудников, должность,
дата приема на работу,
место последней работы,
стаж на дату приема,
признак наличия образования,
признак наличия семьи,
количество детей,
семейное положение,
даты рождения,
тип образования,
форма обучения,
учебное заведение,
дата окончания,
специальность.
Выходные данные: все результаты действий пользователя в работе с базами данных отображаются на экране монитора; эти результаты, выведенные в виде базы данных на экран, являются выходными данными для программы. Также результатом работы с базой данный «Кадровый учет» может быть формирование приказов и вывод их на печать, что значительно облегчает работу пользователя и избавляет от необходимости составлять в ручную в каком-либо текстовом редакторе такие документы как приказ об увольнении или принятии на работу сотрудников и их личных карточек.
3. ОПИСАНИЕ СТРУКТУРЫ ПРОГРАММЫ
Описание переменных
В разделе описаний переменных описаны переменные, назначение которых приведено в таблице 3.1.
Таблица 3.1– Описание переменных программы
| Наименование | Тип | Назначение |
| FO,FS | TextFile | Переменная текстового файла исходного и результирующего |
| tmpstr,str,strslovo | String | Строковые переменные для чтения из файла |
| i,j | integer | Переменные счетчики для циклов |
| count | integer | Переменная хранит количество исправленных символов |
| answ | Word | Используется для определения ответа пользователя на вопрос об исправлении символа |
| UpCh | set of char | Множество заглавных символов |
| ZnCh | set of char | Множество символов разделителей слов |
| OFName | String | Строка, в которой хранится путь к исходному файлу |
| SFName | String | Строка, в которой хранится путь к результирующему файлу |
В программе приведено описание одной вспомогательной процедуры.
Процедура FormCreate вывода исходных значений в компоненты формы для корректного отображения формы в начале работы программы.
Процедура Button1Click для отрытия исходного файла и сохранения пути к нему.
Процедура Button2Click для отрытия результирующего файла и сохранения пути к нему.
Алгоритм основной программы
Алгоритм выполнения основного тела программы приведен на рисунке А.1 в приложении А. Так в процедуре в первую очередь осуществляется привязка файла к файловой переменной и открытие текстового файла для чтения текстовой информации.
Затем производится чтение информации из файла построчно.
Затем в каждой строке выделяются слова.
Затем осуществляется поиск в выделенных словах заглавных символов.
Затем происходит запись в результирующий текстовый файл изменений.
В ходе выполнения работы использовались следующие операции работы с текстовыми файлами:
AssignFile (<Имя файловой переменной>,<Имя файла>);
Имя файла задается либо строковой константой, либо через переменную типа Sting. Имя файла должно соответствовать правилам работающей в данный момент операционной системы. Если строка имени пустая, то связь файловой переменной осуществляется со стандартным устройством ввода-вывода.
Reset (<Имя файловой переменной>);
Открывается файл для чтения из него информации, ему присваивается имя, заданное процедурой Assign.
После работы с файлом он, как правило, должен быть закрыт процедурой CloseFile (<Имя файловой переменной>). Вывод информации производит оператор WRITELN(f: TextFile;S: String). После его выполнения строка S заносится в конец файла, связанного с переменной f.
4. ОПИСАНИЕ ВХОДНЫХ ДАННЫХ
Исходными данными для выполнения является файл, который содержит заглавные символы.
5. ОПИСАНИЕ ВЫХОДНЫХ ДАННЫХ
Выходными данными являются:
Сообщение о завершении проверки файла на наличие в нем заглавных символов;
Сообщение о количестве исправленных символов;
Заполненный результирующий текстовый файл.
6. ИНСТРУКЦИЯ ОПЕРАТОРУ
Разработанная программа представляет собой исполняемый файл Luchshev.exe размером 405 Кбайт. В программе реализован алгоритм проверки текстового файла на наличие в нем заглавных символов.
После запуска программы появляется окно, изображенное на рисунке 4.1.
Рисунок 4.1 – Главное окно программы
После этого пользователь должен задать путь к файлу. На рисунке 4.2 показан пример диалогового окна для открытия файла.
Рисунок 4.2 – Пример отскрытия исходного файла
Пример сообщения о нахождении заглавного символа приведен на рисунке 4.3.
Рисунок 4.3– Сообщение о нахождении заглавного символа
Пример окна с результатом проверки текстового файла приведен на рисунке 4.4.
Рисунок 4.4- Результирующее окно.
Результат проверки записывается в выбранный результирующий файл находящийся в выбранной директории.
Функционирование программы полностью соответствует заданию.
Данная курсовая работа была выполнена в полном соответствии поставленному заданию и отлажена в среде Delphi 7.0. В ходе выполнения курсовой работы была разработана программа для проверки текстового файла.
В ходе выполнения курсового проекта были проведен - анализ технического задания и постановка задачи проектирования.
Были выделены функции, которыми должна обладать разрабатываемая программа.
Был разработан алгоритм программы, предназначенной для выполнения сформированных функций.
Согласно разработанному алгоритму была составлена и отлажена программа алгоритмическом языке программирования Delphi. В ходе разработки программы проводилось ее тестирование и отладка на тестовых наборах. Для написанной программы разработана инструкция оператора с указанием порядка выполняемых действий.
Результаты работы оформлены в виде пояснительной записки.
В ходе разработки программы были закреплены навыки работы:
Командами ввода-вывода как на экран, так и в текстовые файлы,
Использования процедур,
Команды обработки массивов,
Команды для реализации циклов с заданным числом повторений;
Команды проверки условий и реализации ветвлений.
В результате выполнения данной курсовой работы, мы убедились в широких возможностях языка программирования Delphi, закрепили практические навыки программирования в cреде Delphi.
Перечень ссылок
1. Зуев Е.А. Программирование на языке Delphi 6.0,7.0. – М.: Радио и связь, Веста, 1993.
2. Фаронов В.В. Delphi 7.0. Начальный курс. - М.: Нолидж, 2000.
| |
Алгоритм программы
Рисунок А.1 – Алгоритм программы
Рисунок А.2 – Алгоритм основной процедуры программы
ПРИЛОЖЕНИЕ Б
Листинг программы
4. Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
5. Dialogs, StdCtrls;
7. TForm1 = class(TForm)
8. Button1: TButton;
9. Button2: TButton;
10. OpenDialog1: TOpenDialog;
11. SaveDialog1: TSaveDialog;
12. Button3: TButton;
13. Label1: TLabel;
14. Label2: TLabel;
15. Label3: TLabel;
16. Label4: TLabel;
17. Button4: TButton;
18. procedure Button1Click(Sender: TObject);
19. procedure Button2Click(Sender: TObject);
20. procedure FormCreate(Sender: TObject);
21. procedure Button3Click(Sender: TObject);
22. procedure Button4Click(Sender: TObject);
24. { Private declarations }
26. { Public declarations }
29. Form1: TForm1;
30. OFName,SFName:String;
31. implementation
33. procedure TForm1.Button1Click(Sender: TObject);
35. if OpenDialog1.Execute then
36. OFName:=OpenDialog1.FileName;
37. if OFName<>"" then begin
38. Button1.Enabled:=False;
39. Button2.Visible:=True;
40. Label1.Caption:="Путь к файлу для проверки: "+OFName;
41. Label2.Visible:=True;
45. procedure TForm1.Button2Click(Sender: TObject);
50. if SaveDialog1.Execute then
51. SFName:=SaveDialog1.FileName;
52. if Pos(".txt",SFName)=0 then SFName:=SFName+".txt";
53. if SFName=OFName then
54. ShowMessage("Выберите другой файл для сохранения результата")
57. if (SFName<>"") and (b) then begin
58. Button2.Enabled:=False;
59. Label2.Caption:="Путь к результирующему файлу: "+SFName;
60. Button3.Visible:=True;
61. Label3.Visible:=True;
62. Label3.Caption:="Для начала проверки нажмите на кнопку "Проверить"";
65. procedure TForm1.FormCreate(Sender: TObject);
67. Button2.Visible:=False;
68. Label2.Visible:=False;
69. Button3.Visible:=False;
70. Label3.Visible:=False;
71. Button4.Visible:=False;
72. Label4.Visible:=False;
73. Label1.Caption:="Нажмите на кнопку "Открыть" и выберите файл для проверки";
75. procedure TForm1.Button3Click(Sender: TObject);
77. FO,FS:TextFile;
78. i,j,count:integer;
79. str,strslovo,tmpstr:String;
80. ZnCh,UpCh:set of Char;
84. ZnCh:=[".",",","!","?"];
85. UpCh:=["A".."Z","А".."Я"];
86. AssignFile(FO,OFName);
87. AssignFile(FS,SFName);
91. if IOResult<>0 then begin
92. ShowMessage("Произошли проблемы с открытием файла. Программа будет завершена");
96. Rewrite(FS);
97. while not Eof(FO) do begin
98. Readln(FO,str);
99. strslovo:="";
100. for i:=1 to Length(str) do begin
101. if (str[i] in ZnCh) or (str[i]=" ") then begin
102. for j:=1 to Length(strslovo) do begin
a. if strslovo[j] in UpCh then begin
b. answ:=MessageDlg("В слове ""+strslovo+"" найдена заглавная буква ""+strslovo[j]+"". Заменить ее на малую?",mtInformation,,0);
c. if answ=mrYes then begin
i. tmpstr:=strslovo[j];
ii. tmpstr:=AnsiLowerCase(tmpstr);
iii. Delete(strslovo,j,1);
iv. Insert(tmpstr,strslovo,j);
104. Write(FS,strslovo+str[i]);
105. strslovo:="";
108. strslovo:=strslovo+str[i];
110. Writeln(FS,"");
112. CloseFile(FO);
113. CloseFile(FS);
114. Label3.Caption:="Проверка файла завершена. Исправлено "+IntToStr(count)+" заглавных букв.";
115. Button3.Enabled:=False;
116. Button4.Visible:=True;
117. Label4.Visible:=True;
120. procedure TForm1.Button4Click(Sender: TObject);
122. OFName:="";
123. SFName:="";
124. Button1.Enabled:=True;
125. Button2.Visible:=False;
126. Button2.Enabled:=True;
127. Button3.Visible:=False;
128. Button3.Enabled:=True;
129. Button4.Visible:=False;
130. Label2.Visible:=False;
131. Label3.Visible:=False;
132. Label4.Visible:=False;
133. Label1.Caption:="Нажмите на кнопку "Открыть" и выберите файл для проверки";
| |
Результаты решения программы
ГОСТ 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
При сопровождении программного средства описание логической структуры является материалом, по которому находится та часть текста программы, которую нужно модифицировать или модернизировать. При описании логики работы программы в соответствии с приводимой схемой алгоритма необходимо описать работу, выполняемую каждым блоком.
В разделе "Используемые технические средства" необходимо указать типы ЭВМ, конфигурацию вычислительного комплекса, для которого разработано описываемое программное средство. Если программа учитывает особенности операционной среды, то следует указать ту операционную среду, в которой работает эта программа.
указывается способ вызова программы с соответствующего носителя данных и входные параметры при запуске программы. Допускается указывать объем программы, сведения об использовании оперативной и внешней памяти. Необходимо указать, как фактически начинается выполнение программы, какие сообщения ожидаются в течение этого начального периода.В разделе "Входные данные" необходимо указать характер, организацию и предварительную подготовку входных данных. Необходимо описать все типы входных данных, назначение каждого типа. Если входная информация может быть представлена последовательностью некоторых крупных логических единиц, то необходимо описать способы объединения входных данных в эти более крупные логические единицы. Необходимо указать формат и назначение всех полей логической записи данных. Необходимо указать также ограничения на размеры и количество входных данных. Выходные данные описываются с той же степенью подробности, что и входные. Если выходными данными являются одно или несколько сообщений, то необходимо указать, как пользователь должен интерпретировать каждое сообщение, как он может использовать информацию, содержащуюся в каждом сообщении.
