ГОСТ 19.106—78 Единая система программной документации. Требования к программным документам, выполненным печатным способом. Unified system for program documentation. Requirements for printed documents. УДК 651.7/.78:002:006.354 МКС 35.080. Редакция от 04.11.2023.
1 Общие требования ГОСТ 19.106-78
1.1 Состав и структура программного документа устанавливаются по ГОСТ 19.105—78 [из 1.1 ГОСТ 19.106—78]
1.2 Программный документ выполняют одним из следующих печатных способов:
- машинописным — на одной стороне листа, через два интервала; допускается через один или полтора интервала, если обеспечивается пригодность к микрофильмированию по ГОСТ 13.1.002—80 (разд. 1);
- машинным — на одной стороне листа, с расстоянием между основаниями строк, обеспечивающим пригодность к микрофильмированию;
- типографским — в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом.
- При выполнении программного документа допускается сочетание печатных способов, указанных в п. 1.2 настоящего стандарта.
- Допускается выполнение документа или его части рукописным способом — на одной стороне листа черными чернилами или тушью, основным чертежным шрифтом по ГОСТ 2.304—81 с высотой букв не менее 2,5 мм.
[из 1.2 ГОСТ 19.106—78]
1.3 Вписывать в программные документы, выполненные машинописным, машинным и рукописным способами, отдельные слова, формулы, условные знаки (oт руки чертежным шрифтом), буквы латинского и греческого алфавитов, а также выполнять схемы и рисунки необходимо черными чернилами или тушью [из 1.3 ГОСТ 19.106—78]
1.4 При машинописном, машинном и рукописном способах выполнения документа опечатки и графические неточности, обнаруженные в процессе выполнения, допускается исправлять подчисткой некачественно выполненной части текста (чертежа) и нанесением на том же листе исправленного текста (графики) машинописью или черной тушью в зависимости от способа выполнения документа.
Повреждения листов документов, помарки и следы не полностью удаленного прежнего текста (графики) не допускаются [из 1.4 ГОСТ 19.106—78]
1.5 Программные документы оформляют:
- на листах формата A4 (ГОСТ 2.301—68) — при изготовлении документа машинописным или рукописным способом (форма 1). Допускается оформление на листах формата А3 (форма 2);
- на листах форматов А4 и А3, предусматриваемых выходными характеристиками устройств вывода данных — при изготовлении документа машинным способом. Допускаются отклонения размеров листов, соответствующих форматам А4 и А3, определяемые возможностями применяемых технических средств;
- на листах типографских форматов при изготовлении документа типографским способом.
[из 1.5 ГОСТ 19.106—78]
1.6 Материалы программного документа располагают в следующей последовательности:
- титульная часть:
- лист утверждения (не входит в общее количество листов документа);
- титульный лист (первый лист документа).
- информационная часть:
- аннотация;
- лист содержания.
- основная часть:
- текст документа (с рисунками, таблицами и т. п.);
- приложения;
- перечень терминов;
- перечень сокращений;
- перечень рисунков;
- перечень таблиц;
- предметный указатель;
- перечень ссылочных документов;
- перечень символов и числовых коэффициентов;
- часть регистрации изменений;
- лист регистрации изменений.
Приложения, перечни терминов, сокращений, рисунков и таблиц, предметный указатель, перечни ссылочных документов, символов и числовых коэффициентов выполняются при необходимости [из 1.6 ГОСТ 19.106—78]
1.7 Перечни терминов и сокращений, предметный указатель, перечень символов и числовых коэффициентов следует составлять в алфавитном порядке.
Остальные перечни составляют в порядке возрастания номеров [из 1.7 ГОСТ 19.106—78]
2 Требования к программным документам, содержащим в основном сплошной текст ГОСТ 19.106-78
2.1 Построение документа ГОСТ 19.106-78
2.1.1 При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела. Каждую часть комплектуют отдельно. Всем частям присваивают обозначение документа в соответствии с ГОСТ 19.103—77.
Части оформляют в соответствии с требованиями настоящего стандарта, при этом в конце содержания первой части следует перечислять обозначения остальных частей.
Допускается включать в документ части текста программы, оформляемые в соответствии с правилами языка, на котором написан текст программы.
Нумерацию страниц документа, а также нумерацию разделов, рисунков и таблиц производят в пределах каждой части. Каждую часть начинают с титульного листа.
Отдельная нумерация страниц документа в пределах раздела и подраздела не допускается.
Лист утверждения выпускают на весь документ с обозначением первой части [из 2.1.1 ГОСТ 19.106—78]
2.1.2 Информационная и основная части программного документа выполняются по форме 1 или 2, где:
- поле 1 — порядковый номер страницы;
- поле 2 — обозначение документа;
- поле 3 — текст документа;
- поле 4 — строка изменений; заполняется в соответствии с требованиями ГОСТ 19.604—78.
Рамку (границы) формата страниц документа допускается не наносить [из 2.1.2 ГОСТ 19.106—78]
2.1.3 Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей [из 2.1.3 ГОСТ 19.106—78]
2.1.4 Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
В содержание документа включают номера разделов, подразделов, пунктов и подпунктов, имеющих заголовок, их наименование и номера страниц; номера и наименование (при наличии) приложений программного документа и номера страниц; прочие наименования (перечень рисунков, таблиц и т.п.) и номера страниц.
Наименования, включенные в содержание, записывают строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры [из 2.1.4 ГОСТ 19.106—78]
2.1.6 Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.
Раздел — первая ступень деления, обозначенная номером и снабженная заголовком.
Подраздел — часть раздела, обозначенная номером и имеющая заголовок.
Пункт — часть раздела или подраздела, обозначенная номером. Может иметь заголовок.
Подпункт — часть пункта, обозначенная номером, может иметь заголовок.
Абзац — логически выделенная часть текста, не имеющая номера.
При отсутствии разделов в тексте документа его первым структурным элементом является пункт.
Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.
Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефиса перед текстом.
Не рекомендуется делать ссылки на элементы перечисления.
Каждый структурный элемент начинается с абзацного отступа [из 2.1.6 ГОСТ 19.106—78]
2.1.7 Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
Допускается при машинном способе выполнения документа заголовки подразделов и пунктов записывать шрифтом, имеющимся на печатающем устройстве.
Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
Если заголовок состоит из двух предложений, их разделяют точкой.
Каждый раздел рекомендуется начинать с нового листа [из 2.1.7 ГОСТ 19.106—78]
2.1.8 Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела, должно быть равно:
- при выполнении документа машинописным способом — двум интервалам;
- при выполнении рукописным способом — 10 мм;
- при выполнении машинным способом — не менее трех высот шрифта.
Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
- при выполнении документа машинописным способом — трем машинописным интервалам;
- при выполнении рукописным способом — не менее 15 мм;
- при выполнении машинным способом — не менее четырех высот шрифта.
Расстояние между основаниями строк заголовка принимают таким, как в тексте.
При типографском способе издания документов указанные расстояния оформляют по правилам для типографских изданий [из 2.1.8 ГОСТ 19.106—78]
2.1.9 Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
Разделы должны иметь порядковый номер (1, 2 и т.д.).
В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой (2.1, 3.1 и т.д.).
При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т. д.).
Пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов приведен в справочном приложении 2 [из 2.1.9 ГОСТ 19.106—78]
2.2 Текст документа ГОСТ 19.106-78
2.2.1 Текст документа должен быть кратким, четким, исключающим возможность неоднозначного толкования.
Термины и определения должны быть едиными и соответствовать установленным стандартами, а при их отсутствии — общепринятым в научно–технической литературе, и приводиться в перечне терминов [из 2.2.1 ГОСТ 19.106—78]
2.2.2 Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316—68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316—68, следует приводить в перечне принятых сокращений [из 2.2.2 ГОСТ 19.106—78]
2.2.3 Для выделения отдельных понятий допускается изменять интервалы между словами, а также печатать отдельные слова или части текста шрифтом, отличным от печати основного текста, например:
UNGATLG — указывает, что запись каталога, относящаяся к исходному набору данных, должна быть исключена.
ТО=устройство=список — указывает носители данных, на которые осуществляется...
АВС3091 СИНТАКСИЧЕСКАЯ ОШИБКА
ПРИЧИНА. Указанный в сообщении...
ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется...
ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить...
[из 2.2.3 ГОСТ 19.106—78]
2.2.4 Необходимые пояснения к тексту документа могут оформляться сносками.
Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)...».
Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению в целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведенной в левой части страницы [из 2.2.4 ГОСТ 19.106—78]
2.3 Иллюстрации ГОСТ 19.106-78
2.3.1 Иллюстрации могут быть расположены в тексте документа и (или) в приложениях.
Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа.
Ссылки на иллюстрации дают по типу: «рис. 12» или «(рис. 12)».
Ссылки на ранее упомянутые иллюстрации дают с сокращенным словом «смотри», например, «см. рис.12».
Иллюстрации могут иметь тематический заголовок и подрисуночный текст, поясняющий содержание иллюстрации.
Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст — под ней. Номер иллюстрации помещают под поясняющими данными [из 2.3.1 ГОСТ 19.106—78]
2.4 Формулы ГОСТ 19.106-78
2.4.1 Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках, на уровне формулы.
В пределах всего документа или его частей, в случае деления документа на части, формулы имеют сквозную нумерацию.
Ссылки в тексте на порядковый номер формулы дают в скобках, например: «в формуле (3)».
При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: «в формуле (1.4)» [из 2.4.1 ГОСТ 19.106—78]
2.4.2 Значения символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения их под формулой допускается не приводить [из 2.4.2 ГОСТ 19.106—78]
2.4.3 Размерность одного и того же параметра в пределах одного документа должна быть постоянной [из 2.4.3 ГОСТ 19.106—78]
2.5 Ссылки ГОСТ 19.106-78
2.5.1 В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначения.
Ссылаться следует на документ в целом или на его разделы и приложения (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
При ссылках на документ допускается проставлять в квадратных скобках его порядковый номер в соответствии с перечнем ссылочных документов.
Допускается указывать только обозначение документа и (или) разделов без указания их наименований. Ссылки на отдельные подразделы, пункты и иллюстрации другого документа не допускаются. Допускаются ссылки внутри документа на пункты, иллюстрации и отдельные подразделы.
[из 2.5.1 ГОСТ 19.106—78]
2.6 Таблицы ГОСТ 19.106-78
2.6.1 Цифровой материал для достижения лучшей наглядности и сравнимости показателей, как правило, следует оформлять в виде таблицы [из 2.6.1 ГОСТ 19.106—78]
2.6.2 Оформление таблиц должно производиться в соответствии с требованиями ГОСТ 1.5—85.
Таблица может иметь заголовок, который следует выполнять строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры [из 2.6.2 ГОСТ 19.106—78]
2.6.3 Сноски к таблицам располагают непосредственно под таблицей, например:
Наборы данных, используемые для распечатки
Стандартное имя | Используемое устройство | |
Для информационной распечатки | SSSSSSS1) | Печатающее устройство2) |
Для распечатки во время выполнения программы | РРРРРРРР | Печатающее устройство2) |
- Имя SSSSSSS должно быть задано при настройке операционной системы.
- Для уменьшения простоев центрального процессора из–за операций ввода–вывода может быть использована магнитная лента.
[из 2.6.3 ГОСТ 19.106—78]
2.7 Примечания ГОСТ 19.106-78
2.7.1 В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
Одно примечание не нумеруется. После слова «Примечание» ставят точку.
Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечания» ставят двоеточие.
Например:
Примечание._____________________________________________________________________________ __________________________________________________________________________________________ или Примечания: 1. _______________________________________________________________________________________ __________________________________________________________________________________________ 2. ________________________________________________________________________________________ ___________________________________________________________________________________________ |
[из 2.7.1 ГОСТ 19.106—78]
2.7.2 Текст примечаний допускается печатать через один интервал [из 2.7.2 ГОСТ 19.106—78]
2.8 Сокращения ГОСТ 19.106-78
2.8.1 Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением:
- сокращений, установленных в ГОСТ 2.316—68, и общепринятых в русском языке;
- сокращений, применяемых для обозначения программ, их частей и режимов работы, в языках управления заданиями, в средствах настройки программы и т.п., обозначаемых буквами латинского алфавита.
Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень принятых сокращений [из 2.8.1 ГОСТ 19.106—78]
2.9 Приложения ГОСТ 19.106-78
2.9.2 Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «Приложение» прописными буквами и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.
При наличии в документе более одного приложения все приложения нумеруют арабскими цифрами (без знака №), например, Приложение 1, Приложение 2 и т.д.
При выпуске приложения отдельным документом на титульном листе под видом документа следует указывать слово «Приложение», а при наличии нескольких приложений указывают также их порядковые номера.
Приложения, выпущенные в виде отдельного документа, обозначают как часть документа. При необходимости в таком приложении может быть помещено «Содержание».
Допускается объединять несколько приложений в отдельную часть программного документа [из 2.9.2 ГОСТ 19.106—78]
2.9.3 Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты, нумеруемые отдельно по каждому приложению [из 2.9.3 ГОСТ 19.106—78]
2.9.4 Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.
Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения [из 2.9.4 ГОСТ 19.106—78]
2.9.5 На приложения должны быть даны ссылки в основном тексте документа.
Все приложения должны быть перечислены в листе «Содержание» [из 2.9.5 ГОСТ 19.106—78]
3 Требования к программным документам, содержащим текст, разбитый на графы ГОСТ 19.106-78
3.2 Наименования разделов и подразделов записывают в виде заголовков строчными буквами (кроме первой прописной) и подчеркивают.
Расстояния между заголовком и последующим текстом, между текстом и последующим заголовком и между заголовками должны соответствовать указанным в п. 2.1.8 [из 3.2 ГОСТ 19.106—78]
3.3 Примечания в документе оформляют в порядке, изложенном в п. 2.7 [из 3.3 ГОСТ 19.106—78]
3.4 В таблицах и формах, имеющих строки, все записи размещают на каждой строке в один ряд.
Записи не должны сливаться с линиями, разграничивающими строки и графы.
Следует оставлять свободные строки между разделами и подразделами, а в документах большого объема — также внутри разделов и подразделов.
Если в графе документа записан текст в несколько строк, то в последующих графах записи начинают на уровне первой строки. Допускается помещать запись на уровне последней строки, если она занимает одну строку [из 3.4 ГОСТ 19.106—78]
Приложение 2 (справочное) - Структура текста программного документа ГОСТ 19.106-78
[из Приложение 2 (справочное) - Структура текста программного документа ГОСТ 19.106-78]
