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

при выполнении документа машинописным способом — трем машинописным интервалам;

при выполнении рукописным способом — не менее 15 мм;

при выполнении машинным способом — не менее четырех высот шрифта.

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

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

2.1.9. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.

Разделы должны иметь порядковый номер (1, 2 и т. д.).

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

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

При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т. д.).

Пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов приведен в справочном приложении 2.

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

2.1.10. (Исключен, Изм. № 1).

2.2. Текст документа

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

Термины и определения должны быть едиными и соответствовать установленным стандартами, а при их отсутствии — общепринятым в научно-технической литературе, и приводиться в перечне терминов.

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

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

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

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

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

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

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

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

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

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

Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению в целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 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).

2.6. Таблицы

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

2.6.2. Оформление таблиц должно производиться в соответствии с требованиями ГОСТ 1.5-85.

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

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

2.6.3. Сноски к таблицам располагают непосредственно под таблицей, например:

Наборы данных, используемые для распечатки Назначение Стандартное имя Используемое устройство Для информационной распечатки SSSSSSS1) Печатающее устройство2) Для распечатки во время выполнения программы РРРРРРРР Печатающее устройство2)

1) Имя SSSSSSS должно быть задано при настройке операционной системы.

2) Для уменьшения простоев центрального процессора из-за операций ввода-вывода может быть использована магнитная лента.

2.7. Примечания

2.7.1. В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.

Одно примечание не нумеруется. После слова „Примечание“ ставят точку.

Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова „Примечания“ ставят двоеточие.

Например;

Примечание. _______________________________________________________________________________________________________________________________

или

Примечания:

1. ________________________________________________________________________________________________________________________________________

2. ________________________________________________________________________________________________________________________________________

2.7.2. Текст примечаний допускается печатать через один интервал.

2.8. Сокращения

2.8.1. Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением:

сокращений, установленных в ГОСТ 2.316-68, и общепринятых в русском языке;

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

Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень принятых сокращений.

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

2.9. Приложения

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

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