12.14 Примечания

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

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

Примеры

Примечание - ____________________________________________________ ____________________________________________________________________.

Примечания

1 _____________________________________.

2 _______________________________________________________________ ___________________________.

12.15 Сноски

12.15.1 Если необходимо пояснить отдельные данные, приведенные в ПЗ, то эти данные следует обозначить надстрочными знаками сноски.

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

12.15.2 Знак сноски ставят непосредственно после того слова, числа, символа, предложения, к которому дается пояснение, а также перед текстом самого пояснения.

12.15.3 Знак сноски выполняют арабскими цифрами со скобкой и помещают на уровне верхнего обреза шрифта.

Пример – «… смазочное устройство²⁾…»

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

12.16 Сокращения

12.16.1 В тексте ПЗ допускаются сокращения, которые применяются только с цифровыми значениями, например, с. – страница; г. – год; гг. – годы; мин. – минимальный; макс. – максимальный; абс. – абсолютный; отн. – относительный, а также общепринятые сокращения, установленные правилами русской орфографии и ГОСТ 7.12, например, т.е. – то есть; т.д. – так далее; т.п. – тому подобное; и др. – и другие; пр. – прочие; см. – смотри; номин. – номинальный; наим. – наименьший; наиб. – наибольший; св. – свыше и др.

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

12.16.2 Если в ПЗ принята особая система сокращения слов и наименований, то их перечень должен быть приведен в структурном элементе «Обозначения и сокращения».

12.17 Схемы программной документации

12.17.1 Правила выполнения схем алгоритмов, программ, данных и систем, а также применение в них условных обозначений устанавливает ГОСТ 19.701.

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

12.7.2 Правила применения символов

12.7.2.1 Расположение символов в схеме должно быть равномерным. Углы и другие параметры в символах не должны изменяться. Символы должны быть, по возможности, одного размера.

12.17.2.2 Соотношение геометрических размеров символов (рисунок 29) определяется на основе минимального параметра «а», который выбирается из ряда 10, 15, 20 мм и может быть увеличен на число, кратное пяти. Соотношение большего и меньшего размеров должно составлять 1,5.

Рисунок 29

12.17.2.3 При большом объеме текста, помещаемого внутри символа, превышающего его размеры, применяют символ «Комментарий». Если использование символов «Комментарий» может запутать или разрушить ход схемы, текст следует помещать на отдельном листе с перекрестной ссылкой на символ.

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

Рисунок 30

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

Рисунок 31

12.17.2.6 При необходимости ссылки на документацию текст на схеме для символов, отображающих способы вывода, должен размещаться справа над символом, а текст для символов, отображающих способы ввода – справа под символом (рисунок 32).

Рисунок 32

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

При подробном представлении первого и последнего символа должен быть использован символ указания конца. Первый символ указателя конца должен содержать ссылку, которая имеется также в символе с полосой (рисунок 33б).

Рисунок 33

12.17.3 Правила выполнения соединений

12.17.3.1 Потоки данных или потоки управления в схемах показываются линиями. Направление потока слева направо и сверху вниз считается стандартным. При направлении, отличным от стандартного, на линии устанавливается стрелка.

12.17.3.2 Линии в схемах должны подходить к символам либо слева, либо сверху, а исходить либо справа, либо снизу. Линии должны быть направлены к центру символа.

12.17.3.3 При необходимости линии в схемах разрывают для избежания излишних пересечений или слишком длинных линий, а также, если схема состоит из нескольких страниц. Соединитель в начале разрыва называется внешним соединителем (рисунок 34а), а соединитель в конце разрыва – внутренним соединителем (рисунок 34б).

Рисунок 34

12.17.3.4 В схемах следует избегать пересечения линий. Пресекающиеся линии не имеют логической связи между собой, поэтому изменение направления в точках пересечения не допускается (рисунок 35).

Рисунок 35

1 2.17.3.5 Две или более входящие линии могут объединяться в одну исходящую линию. Если две или более линий объединяются в одну линию, место объединения должно быть смещено (рисунок 36).

Рисунок 36