Основные надписи титульного листа

3.1. Титульный лист заполняют по форме и правилам, установленным для ЛУ, при этом:

· поле 1 - заполняют по требованию заказчика;

· поле 2 - не заполняют;

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

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

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

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

· поле 5 - указывают объём документа;

· поле 6- не заполняют;

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

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

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

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

3.2. На титульном листе в левом верхнем углу должна быть надпись:

Утвержден----------------------обозначение ЛУ

Пример заполнения титульного листа приведён в справочном приложении 3.

ОСНОВНЫЕ НАДПИСИ В ТЕКСТЕ ДОКУМЕНТА.

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

4.2. Содержание и правила выполнения основных надписей последующих листов программных документов, выполненных печатным способом, приведены в ГОСТ 19.106-78.

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

ИНФОРМАЦИОННЫЕ ДАННЫЕ О СООТВЕТСТВИИ ГОСТ 19.104-78
СТ СЭВ 2088-80

Разд. 1 и 2 ГОСТ 19.104-78 соответствует разд. 2 СТ СЭВ 2088-80

Разд. 3 ГОСТ 19.104-78 соответствует разд. 3 СТ СЭВ 2088-80

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

ПРИМЕР ЗАПОЛНЕНИЯ ЛИСТА УТВЕРЖДЕНИЯ

	СОГЛАСОВАНО Руководитель ЦКБ (подпись) А. А. Петров 21.03.1978		УТВЕРЖДАЮ Начальник управления (подпись) Н. Н. Сизов 22.03.1978
ЕДИНАЯ СИСТЕМА ЭЛЕКТРОННЫХ ВЫЧИСЛИТЕЛЬНЫХ МАШИН ОПЕРАЦИОННАЯ СИСТЕМА Загрузчик Руководство программиста ЛИСТ УТВЕРЖДЕНИЯ А.В.00001-01 33 01-1-ЛУ (вид носителя данных) Листов 2
СОГЛАСОВАНО Руководитель ВЦ (подпись) И. И. Павлов 20.02 1978 Главный инженер завода (подпись) А. А. Иванов 20.02.1978		Представители предприятия-разработчика Главный инженер НИИавтоматика (подпись) А. В. Басов 15.02.1978 Начальник отдела 12 (подпись) Г. Ф. Сизов 15.02.1978 Руководитель разработки (подпись) Л. А. Соколов 15.02.1978 Исполнитель (подпись) А. М. Пашин 15.02.1978 Нормоконтролер (подпись) Г. В. Громова 15.02.1978
Литера

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

ПРИМЕР ЗАПОЛНЕНИЯ ТИТУЛЬНОГО ЛИСТА

	УТВЕРЖДЕНО А.В.00001-01 33 01-1-ЛУ
ЕДИНАЯ СИСТЕМА ЭЛЕКТРОННЫХ ВЫЧИСЛИТЕЛЬНЫХ МАШИН ОПЕРАЦИОННАЯ СИСТЕМА Загрузчик Руководство программиста А.В.00001-01 33 01-1 (вид носителя данных) Листов 40
Литера

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

ГОСТ 19.105-78 Общие требования к программным документам

УДК 651.7/.78:002:006.354

Группа Т55

 

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

Единая система программной документации	ГОСТ 19.105-78* (СТ СЭВ 2088-80)
ОБЩИЕ ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ
United system for program documentation. General requirement for program documents.

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

С 01.01 1980 г.

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

Стандарт соответствует СТ СЭВ 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.

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

ИНФОРМАЦИОННЫЕ ДАННЫЕ О СООТВЕТСТВИИ ГОСТ 19.105-78
СТ СЭВ 2088-80

Разд. 3 ГОСТ 19.105-78 соответствует разд. 4 (пп. 4.2, 4.3) СТ СЭВ 2088-80.

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

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

ГОСТ 19.106-78 Требования к программным документам, выполненным печатным способом

УДК 651.7/.78:002:006.354

Группа Т55

 

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

Единая система программной документации	ГОСТ 19.106-78* (СТ СЭВ 2088-80)
ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
United system for program documentation. requirement for printed documents.

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

С 01.01 1980 г.

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

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

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

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

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

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

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

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

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

Примечания:

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

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

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

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

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

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

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

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

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

Форма 1.

 

Форма 2.

 

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

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

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

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

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

o аннотация;

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

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

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

o приложения;

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

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

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

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

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

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

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

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

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

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

(Измененная редакция, Изм. № 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. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.

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

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