Читаем Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ полностью

Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ

2.2.2. Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в перечне принятых сокращений.

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

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

ТО=устройство=список — указывает носители данных, на которые осуществляется…

ABC3091 СИНТАКСИЧЕСКАЯ ОШИБКА

ПРИЧИНА. Указанный в сообщении…

ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется…

ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить…

2.2.4. Необходимые пояснения к тексту документа могут оформляться сносками.

Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: „печатающее устройство²⁾…“ или „бумага⁵⁾…“.

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

2.3. Иллюстрации

2.3.1. Иллюстрации могут быть расположены в тексте документа и (или) в приложениях.

Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.

В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа.

Ссылки на иллюстрации дают по типу: „рис. 12“ или „(рис. 12)“.

Ссылки на ранее упомянутые иллюстрации дают с сокращенным словом „смотри“, например, „см. рис. 12“.

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

Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст — под ней. Номер иллюстрации помещают под поясняющими данными.

(Измененная редакция, Изм. № 1).

2.4. Формулы

2.4.1. Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках, на уровне формулы.

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

Ссылки в тексте на порядковый номер формулы дают в скобках, например: „в формуле (3)“.

При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: „в формуле (1.4)“.

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

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

(Измененная редакция, Изм. № 1).

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

2.5. Ссылки

2.5.1. В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначения.

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

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

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

(Измененная редакция, Изм. № 1).