ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙДОКУМЕНТАЦИИ

ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ,
ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ

ГОСТ 19.106-78

(СТ СЭВ2088-80)

МОСКВА - 1979

ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР

Постановлением Государственного комитета СССР по стандартам от 18декабря 1978 г. № 3350 срок введения установлен

с 01 011980

* Переиздание (Ноябрь 1987 г.) с Изменением №1,утвержденным в сентябре 1981г. (ИУС 11-81).

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

Стандарт не распространяется напрограммный документ «Текст программы».

Стандарт соответствует СТ СЭВ 2088-80в части установления структуры и требований к изложению программных документов(см. справочное приложение 1).

1. ОБЩИЕ ТРЕБОВАНИЯ

1.1. Состав и структурапрограммного документа устанавливаются по ГОСТ19.105-78.

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

машинописным - на одной стороне листа, через два интервала; допускаетсячерез один или полтора интервала, если обеспечивается пригодность кмикрофильмированию по ГОСТ 13.1.002 -80 (разд. 1);

машинным - на одной стороне листа, с расстоянием между основаниямистрок, обеспечивающим пригодность к микрофильмированию;

типографским - в соответствии с требованиями, предъявляемыми кизданиям, изготовляемым типографским способом.

Примечания:

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

2. Допускается выполнение документа или его части рукописным способом -на одной стороне листа черными чернилами или тушью, основным чертежным шрифтомпо ГОСТ 2.304-81 свысотой букв не менее 2,5 мм.

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

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

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

1.5. Программные документыоформляют:

на листах формата А4 (ГОСТ 2.301-68) - при изготовлениидокумента машинописным или рукописным способом (форма1) Допускается оформление на листах формата А3 (форма 2);

на листах форматов А4 и А3,предусматриваемых выходными характеристиками устройств вывода данных - приизготовлении документа машинным способом. Допускаются отклонения размеровлистов, соответствующих форматам А4 и А3, определяемые возможностями применяемыхтехнических средств;

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

1.6. Материалы программногодокумента располагают в следующей последовательности:

титульная часть:

лист утверждения (не входитв общее количество листов документа);

титульный лист (первый листдокумента);

информационная часть:

аннотация;

лист содержания;

основная часть:

текст документа (срисунками, таблицами и т. п.);

приложения;

перечень терминов;

перечень сокращений;

перечень рисунков;

перечень таблиц;

предметный указатель;

перечень ссылочныхдокументов;

перечень символов и числовыхкоэффициентов;

часть регистрации изменений;

лист регистрации изменений.

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

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

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

Остальные перечни редакция составляют в порядкевозрастания номеров.

(Введен дополнительно, Изм. № 1).

Форма 1

2.ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ,
СОДЕРЖАЩИМ В ОСНОВНОМ СПЛОШНОЙ ТЕКСТ

2.1.Построение документа

2.1.1. При необходимостидопускается делить документ на части. Деление на части осуществляется на уровнене ниже раздела. Каждую часть комплектуют отдельно. Всем частям присваиваютобозначение документа в соответствии с ГОСТ19.103-77.

Форма 2.

 

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

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

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

Отдельная нумерация страниц документа в пределахраздела и подраздела не допускается.

Лист утверждения выпускают на весь документ собозначением первой части.

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

2.1.2. Информационная и основная части программного документавыполняются по форме 1 или 2, где:

поле 1 - порядковый номер страницы;

поле 2 - обозначение документа;

поле 3 - текст документа;

поле 4 - строка изменений; заполняется в соответствиис требованиями ГОСТ19.604-78.

Рамку (границы) формата страниц документа допускаетсяне наносить.

2.1.3. Аннотацию размещают на отдельной(пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.

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

2.1.4. Содержание документа размещают на отдельной(пронумерованной) странице (страницах) после аннотации, снабжают заголовком«СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страницдокумента.

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

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

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

2.1.5. Текст каждого документа, при необходимости,разбивают на пункты, а пункты - на подпункты, независимо от того, разделендокумент на части, разделы и подразделы или нет.

2.1.6. Структурными элементами текста документаявляются разделы, подразделы, пункты, подпункты и перечисления.

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

Подраздел - часть раздела, обозначенная номером иимеющая заголовок.

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

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

Абзац - логически выделенная часть текста, не имеющаяномера.

При отсутствии разделов в тексте документа его первымструктурным элементом является пункт.

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

Внутри подразделов, пунктов и подпунктов могут бытьданы перечисления, которые рекомендуется обозначать арабскими цифрами соскобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефисаперед текстом.

Не рекомендуется делать ссылки на элементыперечисления.

Каждый структурный элемент начинается с абзацногоотступа.

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

2.1.7. Заголовки разделовпишут прописными буквами и размещают симметрично относительно правой и левойграниц текста.

Заголовки подразделовзаписывают с абзаца строчными буквами (кроме первой прописной).

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

Переносы слои в заголовкахне допускаются. Точку в конце заголовка не ставят.

Если заголовок состоит издвух предложений, их разделяют точкой.

Каждый раздел рекомендуетсяначинать с нового листа.

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

2.1.8.Расстояние между заголовком и последующим текстом, а также между заголовкамираздела и подраздела, должно быть равно:

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

при выполнении рукописным способом - 10 мм;

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

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

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

при выполнении рукописным способом - не менее 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 -указывает, что запись каталога, относящаяся к исходному набору данных, должнабыть исключена.

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

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

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

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

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

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).

2.6. Таблицы

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

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

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

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

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

 

Наборы данных, используемые для распечатки

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

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

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

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

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

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

Например:

 

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

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

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

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

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

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

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

2.9Приложения

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

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

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

При наличии в документеболее одного приложения все приложения нумеруют арабскими цифрами (без знака№), например, Приложение 1, Приложение 2 и т.д.

При выпуске приложенияотдельным документом на титульном листе под видом документа следует указыватьслово «Приложение», а при наличиинескольких приложений указывают также их порядковые номера.

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

Допускается объединять несколькоприложений в отдельную часть программного документа.

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

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

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

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

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

2.9.5. На приложения должныбыть даны ссылки в основном тексте документа.

Все приложения должны бытьперечислены в листе «Содержание».

3. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ,
СОДЕРЖАЩИМ ТЕКСТ, РАЗБИТЫЙ НА ГРАФЫ

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

3.2. Наименования разделов иподразделов записывают в виде заголовков строчными буквами (кроме первойпрописной) и подчеркивают.

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

3.3. Примечания в документеоформляют в порядке, изложенном в п. 2.7.

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

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

Следует оставлять свободныестроки между разделами и подразделами, а в документах большого объема - такжевнутри разделов и подразделов.

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

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

ПРИЛОЖЕНИЕ 1
Справочное

информационные данные осоответствии гост 19.106-78 ст сэв 2088-80

 

Разд. 1 гост 19.106-78 соответствует разд. 1 иразд. 4 (п. 4.1) СТ СЭВ 2088-80.

Разд. 2 гост19.106-78 соответствуетразд. 4 (пп. 4.4-4.9) СТ СЭВ 2088-80.

(Введено дополнительно, Изм. № 1).

 

ПРИЛОЖЕНИЕ 2
Справочное

 

СОДЕРЖАНИЕ