|
УДК 651.7/.78:002:006.354 |
Группа Т55 |
|
Единая система программной документации |
ГОСТ 19.106-78*(СТ СЭВ 2088-80) |
ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, | |
|
United system for program documentation. |
Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен
с 01.01 1980 г.
Настоящий стандарт устанавливает правила выполнения программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для печатного способа выполнения.
Стандарт не распространяется на программный документ «Текст программы».
Стандарт соответствует СТ СЭВ 2088-80 в части установления структуры и требований к изложению программных документов (см. справочное приложение 1).
1.1. Состав и структура программного документа устанавливается по ГОСТ 19.105-78.
1.2. Программный документ выполняют одним из следующих печатных способов:
Примечания:
1. При выполнении программного документа допускается сочетание печатных способов, указанных в п. 1.2. настоящего стандарта.
2. Допускается выполнение документа или его части рукописным способом - на одной стороне листа черными чернилами или тушью, основным чертёжным шрифтом по ГОСТ 2.304-68 с высотой букв не менее 2,5мм.
1.3. Вписывать в программные документы, выполненные машинописным, машинным и рукописным способами, отдельные слова, формулы, условные знаки (от руки чертёжным шрифтом), буквы латинского и греческого алфавитов, а так же выполнять схемы и рисунки необходимо чёрными чернилами или тушью.
1.4. При машинописном, машинном и рукописном способах выполнения документа опечатки и графические неточности, обнаруженные в процессе выполнения допускается исправлять подчисткой некачественно выполненной части текста (чертежа) и нанесением на том же листе исправленного текста (графики) машинописью или чёрной тушью в зависимости от способа выполнения документа.
Повреждение листов документов, помарки и следы неполностью удаленного текста (графики) не допускаются.
1.5. Программные документы оформляют:
Форма 1.
Форма 2.
1.6. Материалы программного документа располагают в следующей последовательности:
Приложения, перечни терминов, сокращений, рисунков и таблиц, предметных указатель, перечни ссылочных документов, символов и числовых коэффициентов выполняются при необходимости.
(Измененная редакция, Изм. № 1)
1.7. Перечни терминов и сокращений, предметный указатель, перечень символов и числовых коэффициентов следует составлять в алфавитном порядке.
Остальные перечни составляют в порядке возрастания номеров.
(Введен дополнительно, Изм. № 1)
2.1.1. При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела. Каждую часть комплектуют отдельно. Всем частям присваивают обозначение документа в соответствии с ГОСТ 19.103-77.
Части оформляют в соответствии с требованиями настоящего стандарта, при этом в конце содержания первой части следует перечислять названия остальных частей.
Допускается включать в документ частей текста программы, оформляемых в соответствии с правилами языка, на котором написан текст программы.
Нумерацию страниц документа производят, а также нумерацию разделов, рисунков и таблиц производят в пределах каждой части. Каждую часть начинают с титульного листа.
Отдельная нумерация страниц документа в пределах раздела и подраздела не допускается.
Лист утверждения выпускают на весь документ с обозначением первой части.
(Измененная редакция, Изм. № 1).
2.1.2. Информационная и основная части программного документа выполняются по форме 1 или 2, где:
Рамку (границы) формата страниц документа допускается не наносить.
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. Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
Расстояние между основаниями строк заголовка принимают такие же, как в тексте.
При типографском способе издания документов указанные расстояния оформляют по правилам для типографских изданий.
2.1.9. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
Разделы должны иметь порядковый номер (1, 2 и т. д.).
В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Пример структуры текста программного документа и нумерации его разделов, подразделов, пунктов и подпунктов приведён в справочном приложении 2.
(Измененная редакция, Изм. № 1).
2.1.10. (Исключен, Изм. № 1)
2.2.1. Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
2.2.2. Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в перечне принятых сокращений.
2.2.3. Для выделения отдельных понятий допускается изменять интервалы между словами, а также печатать отдельные слова или части текста шрифтом, отличным от печати основного текста, например:
UNCATLG - указывает, что запись каталога, относящаяся к
исходному набору данных, должна быть исключена.
ТО = устройство = список - указывает носители данных, на которые
осуществляется...
АВС3-91 СИНТАКСИЧЕСКАЯ ОШИБКА
ПРИЧИНА. Указанный в сообщении...
ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется...
ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить...
2.2.4. Необходимые пояснения к тексту документа могут оформляться сносками.
Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
2.3.1. Иллюстрации могут быть расположены в тексте документа и (или) в приложениях.
Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа.
Ссылки на иллюстрации дают по типу: «рис.12» или «(рис.12)».
Ссылки на ранее упомянутые иллюстрации дают с сокращенным словом «смотри», например, «см. рис. 12».
Иллюстрации могут иметь тематический заголовок и подрисуночный текст, поясняющий содержание иллюстрации.
Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющими данными.
(Измененная редакция, Изм. № 1).
2.4.1. Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
В пределах всего документа или его частей, в случае деления документа на части, формулы имеют сквозную нумерацию.
Ссылки в тексте на порядковый номер формулы дают в скобках, например: «в формуле (3)».
При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: «в формуле (1.4)».
2.4.2. Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения из под формулой допускается не приводить.
(Измененная редакция, Изм. № 1).
2.4.3. Размерность одного и того же параметра в пределах одного документа должна быть постоянной.
2.5.1. В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
При ссылках на документ допускается проставлять в квадратных скобках его порядковый номер в соответствии с перечнем ссылочных документов.
Допускается указывать только обозначение документа и (или) разделов без указания их наименований. Ссылки на отдельные подразделы, пункты и иллюстрации другого документа не допускаются. Допускаются ссылки внутри документа на пункты, иллюстрации и отдельные подразделы.
(Измененная редакция, Изм. № 1).
2.6.1. Цифровой материал для достижения лучшей наглядности и сравнимости показателей, как правило, следует оформлять в виде таблицы.
2.6.2. Оформление таблиц должно производиться в соответствии с требованиями ГОСТ 1.5-68.
Таблица может иметь заголовок, который следует выполнять строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры.
(Измененная редакция, Изм. № 1).
2.6.3. Сноски к таблицам располагают непосредственно под таблицей. Например:
Наборы данных, используемые для распечатки
|
Назначение |
Стандартное имя |
Используемое устройство |
| Для информационной распечатки |
SSSSSSS1) | Печатающее устройство2) |
| Для распечатки во время выполнения программы |
РРРРРРРР | Печатающее устройство2) |
1) Имя SSSSSSS должно быть задано при настройке операционной системы.
2) Для уменьшения простоев центрального процессора из-за операций ввода-вывода может быть использована магнитная лента.
2.7.1. В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
Одно примечание не нумеруется. После слова «Примечание» ставят точку.
Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
Например:
П р и м е ч а н и е.
или
П р и м е ч а н и я:
1.
2.
2.7.2. Текст примечаний допускается печатать только через один интервал.
2.8.1. Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением:
Если в документе принята особая система сокращений слов или наименований, то в нем должен быть приведен перечень принятых сокращений.
(Измененная редакция, Изм. № 1).
2.9.1. Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
Приложения оформляют как продолжение данного документа на последующих страницах или выпускают в виде отдельного документа.
2.9.2. Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.
При наличии в документе более одного приложения все приложения нумеруют арабскими цифрами (без знака №), например, ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т. д.
При выпуске приложения отдельным документом, на титульном листе под наименованием документа следует указывать слово «ПРИЛОЖЕНИЕ», а при наличии нескольких приложений указывают также их порядковые номера.
Приложения, выпущенные в виде отдельного документа, обозначают как часть документа. При необходимости в таком приложении может быть помещено «Содержание».
Допускается объединять несколько приложений в отдельную часть программного документа.
(Измененная редакция, Изм. № 1).
2.9.3. Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты, нумеруемые отдельно по каждому отдельному приложению.
2.9.4. Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.
Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения.
(Измененная редакция, Изм. № 1).
2.9.5. На приложения должны быть даны ссылки в основном тексте документа.
Все приложения должны быть перечислены в листе «Содержание».
3.1. Программные документы, содержащие текст, разбитый на графы, при необходимости разделяют на разделы и подразделы, которые не нумеруют. Допускается линии, разграничивающие строки и графы, не наносить.
3.2. Наименования разделов и подразделов записывают в виде заголовков строчными буквами (кроме первой прописной) и подчёркивают.
Расстояние между заголовком и последующим текстом, между текстом и последующим заголовком и между заголовками должны соответствовать указанным в п. 2.1.8.
3.3. Примечания в документе оформляются в порядке, изложенном в п. 2.7.
3.4. В таблицах и формах, имеющих строки, все записи размещают на каждой строке в один ряд.
Записи не должны сливаться с линиями, разграничивающими строки и графы.
Следует оставлять свободные строки между разделами и подразделами, а в документах большого объёма - также внутри разделов и подразделов.
Если в графе документа записан текст в несколько строк, то в последующих графах записи начинают на уровне первой строки. Допускается помещать запись на уровне последней строки, если она занимает одну строку.
(Измененная редакция, Изм. № 1).
ПРИЛОЖЕНИЕ 1
Справочное
Разд. 1 ГОСТ 19.106-78 соответствует разд. 1 и разд. 4 (п. 4.1) СТ СЭВ 2088-80.
Разд. 2 ГОСТ 19.106-78 соответствует разд. 4 (пп. 4.4-4.9) СТ СЭВ 2088-80.
(Введено дополнительно, Изм. № 1).
ПРИЛОЖЕНИЕ 2
Справочное
*Переиздание (Июль 1982 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)