Правила выполнения программной документации
Общие положения
Условные обозначения символов и правила их выполнения в программных документах регламентируются ГОСТ 19.701 – 90.
Стандарт классифицирует все символы на три группы:
- основные (точный тип процесса или носителя данных неизвестен или отсутствует необходимость в описании фактического носителя данных);
- специфические (известен тип процесса или носителя данных или когда необходимо описать фактический носитель данных);
- линейные (отражают потоки данных, переход управления, инициализацию массивов и т.д.)
С точки зрения содержания символы подразделяются на следующие группы.
1) Символы данных.
2) Символы видов носителей.
3) Символы процесса и функций ЭВМ, а также основы логических операций.
4) Символы линий (потоков данных).
5) Специальные символы, используемые для описания и чтения схемы.
Описание символов
Символы данных и видов носителей
Они включают два основных символа и восемь специфических (таблица 1).
Таблица 1
Название символа | Обозначение символа | Описание символа |
Основные символы | ||
Данные | Отображает данные носитель которых не определен | |
Данные | Пригоден для обработки, но носитель которых не определен | |
Специфические символы | ||
Оперативное запоминающее устройство | Отображает данные, хранящиеся в оперативном запоминающем устройстве | |
Запоминающее устройство с прямым доступом | Отображаются данные, хранящиеся в запоминающем устройстве прямым доступом (магнитный диск, магнитный барабан, гибкий магнитный диск) | |
Запоминающее устройство с последовательным доступом | ||
Документ | Отображает данные, представленные на носителе в удобочитаемой форме | |
Ручной ввод | Отображает данные, вводимые вручную во время обработки с устройства любого типа | |
Карта | Отображает данные, представленные на носителе в виде карты | |
Бумажная лента | Отображает данные, представленные в виде бумажной ленты | |
Дисплей | Отображаются данные, представленные на носителе в виде отображающего устройства |
Символы процесса
Они включают один основной символ и пять специфических (таблица2).
Таблица 2
Название символа | Обозначение символа | Описание символа |
Основной символ | ||
Процесс | Отображается функция обработки данных любого вида | |
Специфические символы | ||
Предопределяемый процесс | Отображается предопределенный процесс, состоящий из одной или нескольких операций или шагов программы, которые определены в другом месте (модуль, подпрограмма) | |
Ручная операция | Отображает любой процесс, выполняемый человеком | |
Подготовка | Отображает модификацию команды или группы команд с целью воздействия на некоторую последующую функцию | |
Решение | Отображается функция переключательного типа, имеющая один вход и ряд альтернативных выходов | |
Параллельные действия | Отображает синхронизацию двух или более параллельных операций |
Символы линий
Они включают один основной символ и три специфические (таблица3).
Таблица 3
Название символа | Обозначение символа | Описание символа |
Основной символ | ||
Линия | Отображает поток данных или управления. Указание направления необязательно, но при необходимости разработчиком могут быть добавлены стрелки-указатели | |
Продолжение табл.3 | ||
Название символа | Обозначение символа | Описание символа |
Специфические символы | ||
Передача управления | Обозначает непосредственную передачу управления от одного процесса к другому. | |
Канал связи | Отображает передачу данных по каналу связи | |
Пунктирная линия | Отображает альтернативную связь между двумя и более символами |
Специальные символы
Специальных символов четыре: соединитель, терминатор, комментарий и пропуск (таблица 4).
Таблица 4
Название символа | Обозначение символа | Описание символа |
Соединитель | Используется как внутри листа, так и при расположении схемы на нескольких листах. Он отображает выход из части схемы и используется для продолжения ее в другом месте | |
Терминатор | Отображает выход во внешнюю среду и вход из внешней среды. Так в схеме программы или в схеме взаимодействия программ обозначается начало и конец | |
Комментарий | Используется для добавления описательных компонентов или пояснительных записей в целях объяснения или примечаний | |
Пропуск | … | Используется в схемах для отображения пропуска символов или группы символов |
Правила применения символов
Размеры символов имеют одинаковый размер, который выбирается из размера прямоугольника с отношением сторон 1:1,5 (рисунок 1). Эти размеры регламентированы ГОСТ 2.708-81 для схем вычислительной техники.
L = 1,5H, размер Н выбирается из ряда 10, 15, 20, …мм (через 5 мм).
Рис. 1