Несоблюдение стандарта преследуется по закону

ОБЩИЕ ПОЛОЖЕНИЯ

Unified system for program documentation. 19. 001—77

General principles

Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. № 1268 срок введения установлен

с 01.01.80

Несоблюдение стандарта преследуется по закону

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

НАЗНАЧЕНИЕ ЕСПД

1.1. Единая система программной документации—комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и про­граммной документации.

1.2. В стандартах ЕСПД устанавливают требования, регламен­тирующие разработку, сопровождение, изготовление и эксплуа­тацию программ, что обеспечивает возможность:

унификации программных изделий для взаимного обмена про­граммами и применения ранее разработанных программ в новых разработках;

снижения трудоемкости и повышения эффективности разработ­ки; сопровождения, изготовления и эксплуатации программных изделий;

автоматизации изготовления и хранения программной доку­ментации.

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

ОБЛАСТЬ РАСПРОСТРАНЕНИЯ И СОСТАВ ЕСПД

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

2.2. В состав ЕСПД входят:

основополагающие и организационно-методические стандарты;

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

стандарты, обеспечивающие автоматизацию разработки про­граммных документов.

2.3. Разработка организационно-методической документации, определяющей и регламентирующей деятельность организаций по разработке, сопровождению и эксплуатации программ, должна проводиться на основе стандартов ЕСПД.

КЛАССИФИКАЦИЯ И ОБОЗНАЧЕНИЕ СТАНДАРТОВ ЕСПД

3.1. Стандарты ЕСПД подразделяют на группы, приведенные в таблице.

таблице.

_________________________________________________________________

Код группы Наименование группы

0 Общие положения

1 Основополагающие стандарты

2 Правила выполнения документации разработки

3 Правила выполнения документации изготовле­ния

4 Правила выполнения документации сопровож­дения

5 Правила выполнения эксплуатационной докумен­тации

6 Правила обращения программной документации

7, 8 Резервные группы

9 Прочие стандарты

 

3.2. Обозначения стандартов ЕСПД строят по классификаци­онному признаку.

В обозначение стандарта ЕСПД должны входить:

цифры 19, присвоенные классу стандартов ЕСПД;

одна цифра (после точки), обозначающая код классифика­ционной группы стандартов, указанной в п. 3.1;

двузначное число, определяющее порядковый номер стан­дарта в группе;

двузначное число (после тире), указывающее год регистра­ции стандарта.

Пример обозначения стандарта «Единая система программной документации. Общие положения».

ГОСТ19. 0 01 - 77

Год регистрации стандарта

Порядковый номер стандарта в группе

Классификационная группа стандартов

Класс (стандарты ЕСПД)

Категория стандарта (государственный стандарт)

 

 

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

 

Единая система программной документации ГОСТ

ТЕРМИНЫ И ОПРЕДЕЛЕНИЯ

Unified system for program documentation. 19. 004—80

Terms and definitions

Постановлением Государственного комитета СССР по стандартам от 8 мая 1980 г. № 2051 срок введения установлен

С 01.07.81

 

 

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

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

Для каждого понятия установлен один стандартизованный термин. Применение терминов-синонимов стандартизованного термина запрещается.

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

В стандарте в качестве справочных приведены иностранные эквиваленты стандартизованных терминов на английском языке.

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

 

Термин Определение

1. Алгоритм По ГОСТ 19781-83 Algorithm,

2. Программа вычислительной По ГОСТ 19781—83

Машины

Программа

Program

3. Программирование По ГОСТ 19; 81—83

Programming

4. Документ По ГОСТ 6.10.2—75

Document

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

Program product промышленного производства

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

Program document разработки, изготовления, экс­плуатации и сопровождения

программного изделия

7. Эксплуатационный программ- Программный документ, содержащий сведения, необходимые

ный документ для обеспечения функционирования и эксплуатации программно-

Эксплуатационный документ го изделия

Exploitativc document

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

Program check-out выполнения про­граммы на вычислительной машине

 

9. Отладка программы Обнаружение, локализация и устранение ошибок в программе

Program debugging вычислительной ма­шины

10. Испытание программы Установление соответствия программы вычислительной машины

Program test заданным требо­ваниям и программным документам

11. Настройка программы Формирование конкретного варианта программы

Program setting вычислительной машины, обла­дающего свойством многовариан-

тности, учитывающего состав и структуру технических средств,

возможные режимы работы и классы решаемых задач

12. Сопровождение программного Процесс модификации существующей программы вычислитель-

изделия ной машины, обусловленный необходимостью устранения

Program product maintenance вы­явленных в ней ошибок и (или) изменения ее функциональных

возможностей

 

 

С 01.01.80

ВИДЫ ПРОГРАММ

 

1.1. Программу (по ГОСТ 19781—83) допускается идентифи­цировать и применять самостоятельно и (или) в составе других программ.

1.2. Программы подразделяют на виды, приведенные в табл. 1.

 

Таблица 1

Вид программы Определение

 

Компонент Программа, рассматриваемая как единое целое, выполняющая законченную

функцию и применя­емая самостоятельно или в составе комплекса

Комплекс Программа, состоящая из двух или более ком­понентов и (или) комплексов, выполняющих вза­имосвязанные функции, и применяемая самостоя­тельно или в составе другого комплекса

 

1.3. Документация, разработанная на программу, может ис­пользоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.

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

 

 

ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ

2.1. К программным относят документы, содержащие сведе­ния, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.

2.2. Виды программных документов и их содержание приве­дены в табл. 2.

Таблица 2

Вид программного документа Содержание программного документа

Спецификация Состав программы и документация на нее

Ведомость держателей Перечень предприятий, на которых хранят под-

подлинников линники программных документов

Текст программы Запись программы с необходимыми комментариями

Описание программы Сведения о логической структуре и функционировании программы

Программа и методика Требования, подлежащие проверке при испыта-

испытаний нии программы, а также порядок и методы их контроля

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

экономические и специаль­ные требования, предъявляемые к программе,

необходимые стадии и сроки разработки, виды испытаний

Пояснительная записка Схема алгоритма, общее описание алгоритма и(или) функционирования

программы, а также обоснование принятых технических и технико-

экономических решений

Эксплуатационные Сведения для обеспечения функционирования

документы и эксплуатации программы

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

 

2.3. Виды эксплуатационных документов и их содержание при­ведены в табл. 3.

 

Таблица 3.

Вид эксплуатационного документа Содержание эксплуатационного документа

Ведомость эксплуатацион- Перечень эксплуатационных документов на программу

ных документов

Формуляр Основные характеристики программы, комплек­тность и сведения

об эксплуатации программы

Описание применения Сведения о назначении программы, области' применения, применяемых методах, классе реша­емых задач, ограничениях для применения, ми­нимальной конфигурации технических средств

Руководство системного Сведения для проверки, обеспечения функционирования и

программиста настройки программы на условия конкретного применения

Руководство программиста Сведения для эксплуатации программы

Руководство оператора Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы

Описание языка Описание синтаксиса и семантики языка

Руководство по техничес- Сведения для применения тестовых и диагности-

кому обслуживанию ческих программ при обслуживании технических средств

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

2.4. В зависимости от способа выполнения и характера приме­нения программные документы подразделяются на подлинник, дуб­ликат и копию (ГОСТ 2.102—68), предназначенные для разра­ботки, сопровождения и эксплуатации программы.

2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл. 4.

Таблица 4

Стадии разработки

Код Рабочий проект

вида Вид документа Эскизный Технический компонент комплекс

документа проект проект

— Спецификация — --- m n

05 Ведомость держателей — — — О

подлинников

12 Текст программы — — n О

13 Описание программы — — О О

20 Ведомость эксплуата- — — О О

ционных документов

30 Формуляр — — О О

31 Описание применения — — О О

32 Руководство системно- — — О О

го программиста

33 Руководство програм- — — О О

миста

34 Руководство оператора — — О О

35 Описание языка — — О О

46 Руководство по техни- — — О О

ческому обслуживанию

51 Программа и методика — — О О

испытаний

81 Пояснительная записка О О — —

90—99 Прочие документы О О О О

 

Условные обозначения:

n—документ обязательный;

m —документ обязательный для компонентов, имеющих самостоятельное при­менение;

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

и утверждения технического задания;

— — документ не составляют.

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

2.6. Допускается объединять отдельные виды эксплуатацион­ных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих до­кументов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.

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

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

Технические условия разрабатывают на стадии «Рабочий проект».

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

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

 

СТАДИИ РАЗРАБОТКИ

Unified system for program documentation. 19. 102—77

Development stages

 

С 01.01.80

ДОКУМЕНТОВ

Unified system for program documentation. 19. 103—77

Indexing of programs and program documents

 

С 01.01.80

ОСНОВНЫЕ НАДПИСИ

Unified system for program documentation. 19. 104—78

Basic legends (CT СЭВ 2088—80)

С 01.01.80

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

Стандарт соответствует CT СЭВ 2088—80 в части оформления листа утверждения и титульного листа (см. справочное приложе­ние 1).

ОСНОВНЫЕ ПОЛОЖЕНИЯ

1.1. В состав основных надписей листа утверждения и титуль­ного листа в программных документах входят следующие струк­турные данные:

наименование министерства (ведомства);

наименование документа;

обозначение документа;

сведения о носителе данных, на котором представляется под­линник;

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

сведения о разработчике;

подпись нормоконтролера;

отметка об учете и хранении;

сведения об изменении.

2. ОСНОВНЫЕ НАДПИСИ ЛИСТА УТВЕРЖДЕНИЯ (ЛУ]

2.1. Лист утверждения выпускается на каждый программный документ на листах бумаги формата А4 (ГОСТ 2.301—68) неза­висимо от вида документа, который может быть выполнен на любом носителе данных.

2.2. Обозначение листа утверждения состоит из обозначения документа, к которому относится лист утверждения, и через де­фис — шифра ЛУ.

Лист утверждения не входит в общее количество листов доку­мента.

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

Второй и последующие листы утверждения оформляют в соот­ветствии с разд. 1 ГОСТ 19.106—78, при этом в поле «текст доку­мента» приводят должности и подписи лиц, не уместившихся на первом листе листа утверждения.

2.4. Лист утверждения вносят в спецификацию после утверж­денного документа и хранят на предприятии—держателе подлин­ника документа.

Лист утверждения спецификации также вносят в данную спе­цификацию.

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

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

2.5. Лист утверждения заполняют по форме, приведенной на чертеже:

поле 1 — наименование министерства или ведомства, в систему которого входит организация, разработавшая данный документ. Заполняют по требованию заказчика.

Выше поля 1, в правом верхнем углу, при необходимости, ста­вят специальную отметку (гриф секретности, указание «С пред­приятия не выносить» и т. п.);

поле 2 — в левой части поля — должности и подписи лиц, со­гласовавших документ от организации заказчика при необходимо­сти, в правой части поля — должность и подпись лица, утвердив­шего документ от организации разработчика.

Справа от каждой подписи проставляют инициалы и фамилию лица, подписавшего документ, а ниже подписи — дату подписания.

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

поле 3 — полное наименование программы или программного изделия (прописными буквами), наименование и вид документа.

Наименование документа может быть опущено или объединено с наименованием программы;

поле 4 — обозначение документа и указание вида носителя дан­ных.

Вид носителя данных указывают только в случае выполнения программного документа на носителе данных;

поле 5 — общее количество листов утверждения, например, «Листов З».

Для одного листа поле 5 не заполняют;

поле 6— в правой части поля—должности и подписи руково­дителя организации, выпустившей документ, руководителя подраз­деления, разработавшего документ, руководителя разработки (раз­работчика), исполнителей разработки документа и нормоконтролера.

Справа от каждой подписи проставляют инициалы и фамилию лица, подписавшего документ, а ниже подписи — дату подписа­ния.

При большом количестве согласующих подписей их размещают либо в левой части поля 2, либо в левой части поля 6.

Визы других должностных лиц, если они необходимы на доку­менте, размещают на поле для подшивки ЛУ;

поле 7—год издания (утверждения) документа (без указания слова «год» или «г»);

поле 8— отметка об учете и хранении по ГОСТ 19.601-78;

поле 9— строка изменений по ГОСТ 19.604 —78;

поле 10— литера документа.

Пример заполнения ЛУ приведен в справочном приложении 2. Количество подписей в приложении приведено условно.

ОБЩИЕ ТРЕБОВАНИЯ К ПРОГРАММНЫМ

ДОКУМЕНТАМ

Unified system for program documentation. 19. 105—78

General requirement for program documents (CT СЭВ 2088—801)

 

С 01.01.80

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

Стандарт соответствует CT СЭВ 2088—80 в части общих тре­бований к оформлению информационной, части (см. справочное приложение).

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

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

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

титульной;

информационной;

основной;

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

1.3. Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.

 

ТИТУЛЬНАЯ ЧАСТЬ

2.1. Титульная часть состоит из листа утверждения и титуль­ного листа.

Правила оформления листа утверждения и титульного листа— по ГОСТ 19.104—78.

 

ИНФОРМАЦИОННАЯ ЧАСТЬ

 

3.1. Информационная часть должна состоять из аннотации и содержания.

3.2. Необходимость включения информационной части в раз­личные виды программных документов установлена соответствую­щими стандартами ЕСПД на эти документы.

3.3. В аннотации приводят сведения о назначении документа и краткое изложение его основной части.

3.4. Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят:

обозначение структурного элемента (номер раздела, подраз­дела и т. п.);

наименование структурного элемента;

адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т. п.).

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

ОСНОВНАЯ ЧАСТЬ

 

4.1. Состав и структура основной части программного докумен­та устанавливаются стандартами ЕСПД на соответствующие до­кументы.

ЧАСТЬ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ

5.1. О каждом изменении программного документа в этой части делается запись в соответствии с требованиями ГОСТ 19.603—78.

С 01.01.80

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

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

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

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

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

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

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

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

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

Примечания:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

аннотация:

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

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

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

приложения;

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

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

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

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

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

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

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

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

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

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

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

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

 

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

 

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

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

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

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

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

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

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

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