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

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

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

машинописным — на одной стороне листа, через два интервала; допускается через один или полтора интервала, если обеспечивается пригодность к микрофильмированию по ГОСТ 13.1.002-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).

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

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

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

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

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

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

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

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

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

(Измененная редакция, Изм. № 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 мм;

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

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