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

с 01.01.1980 г.

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

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

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

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

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

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

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

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

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

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

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

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

Стандарты ЕСПД (как и другие ГОСТы) подразделяют на группы,

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

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

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

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

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

Резервные группы;

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

В ЕСПД входят следующие ГОСТы:

ГОСТ 19.001-77 ЕСПД. Общие положения.

ГОСТ 19.005-85 ЕСПД. Р-схемы алгоритмов и программ. Обо­значения условные графические и правила выполнения.

ГОСТ 19.101-77 ЕСПД. Виды программ и программных доку­ментов.

ГОСТ 19.102-77 ЕСПД. Стадии разработки.

ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.

ГОСТ 19.104-78 ЕСПД. Основные надписи.

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

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

ГОСТ 19.201 78 ЕСПД. Техническое задание. Требования к со­держанию и оформлению.

ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержа­нию и оформлению.

ГОСТ 19.301-79 ЕСПД. Порядок и методика испытаний.

ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содер­жанию и оформлению.

ГОСТ 19.402-78 ЕСПД. Описание программы.

ГОСТ 19.403-79 ЕСПД. Ведомость держателей подлинников.

ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.

ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.

ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к со­держанию и оформлению.

ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.

ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению.

ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению.

ГОСТ 19.506-79 ЕСПД. Описание языка. Требования к содержа­нию и оформлению.

ГОСТ 19.507-79 ЕСПД. Ведомость эксплуатационных докумен­тов.

ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслужи­ванию. Требования к содержанию и оформлению.

ГОСТ 19.601-78 ЕСПД. Общие правила дублирования, учета и хранения.

ГОСТ 19.602-78 ЕСПД. Правила дублирования, учета и хранения программных документов, выполненных печатным образом.

ГОСТ 19.603-78 ЕСПД. Общие правила внесения изменений.

ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программ­ные документы, выполняемые печатным способом.

Комплекс стандартов на автоматизированные системы (КСАС)

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

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

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

Стандарты ЕСПД были приняты в конце 70-х годов и дошли до нас в виде, близком к первоначальному. В них отражена практика работы ведомственных вычислительных центров, где эксплуатировались большие ЭВМ. Взаимодействие человека с компьютерной системой тогда было построено совсем не так, как теперь, и осуществлялось через громоздкие пульты, перфокарты и распечатки, а для «простых смертных», решающих прикладные задачи, еще и при посредничестве квалифицированного персонала. Надо ли долго объяснять, насколько эти стандарты к настоящему времени устарели? Достаточно сказать, что им неведомы такие распространенные сегодня документы, как руководство пользователя и руководство администратора .

И все-таки ими продолжают активно пользоваться. Формально «девятнадцатому» есть современная альтернатива. Переведены на русский язык и приняты в России на правах национальных некоторые стандарты ИСО/МЭК в области системной и программной инженерии . Но крупные, в том числе, государственные заказчики переходить на них не торопятся. Это можно объяснить их косностью (или верностью традиции, как вам больше нравится), но лишь отчасти.

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

Стандарты ИСО/МЭК, напротив, содержат много разумных правил содержательного характера, но сложно представить себе процедуру их формальной проверки. Впрочем, никто не мешает применять оба ряда стандартов одновременно, благо, они касаются разных аспектов документирования и друг другу практически не противоречат.

Состав нормативно-технических документов

Обозначение	Наименование
ГОСТ 19.001-77	Общие положения
ГОСТ 19.002-80	Единая система программной документации. Схемы алгоритмов и программ. Правила выполнения
ГОСТ 19.004-80	Единая система программной документации. Термины и определения
ГОСТ 19.005-85	Единая система программной документации. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения
ГОСТ 19.101-77	Единая система программной документации. Виды программ и программных документов
ГОСТ 19.102-77	Единая система программной документации. Стадии разработки
ГОСТ 19.103-77	Единая система программной документации. Обозначение программ и программных документов
ГОСТ 19.104-78	Единая система программной документации. Основные надписи
ГОСТ 19 105-78	Единая система программной документации. Общие требования к программным документам
ГОСТ 19.106-78	Единая система программной документации. Требования к программным документам, выполненным печатным способом
ГОСТ 19.201-78	Единая система программной документации. Техническое задание
ГОСТ 19.202-78	Единая система программной документации. Спецификация. Требования к содержанию и оформлению
ГОСТ 19.301-79	Единая система программной документации. Программа и методика испытаний. Требования к содержанию и оформлению
ГОСТ 19.401-78	Единая система программной документации. Текст программы. Требования к содержанию и оформлению
ГОСТ 19.402-78	Единая система программной документации. Описание программы
ГОСТ 19 403-79	Единая система программной документации. Ведомость держателей подлинников
ГОСТ 19.404-79	Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению
ГОСТ 19.501-78	Единая система программной документации. Формуляр. Требования к содержанию и оформлению
ГОСТ 19.502-78	Единая система программной документации. Описание применения . Требования к содержанию и оформлению
ГОСТ 19.503-79	Единая система программной документации. Руководство системного программиста . Требования к содержанию и оформлению
ГОСТ 19.504-79	Единая система программной документации. Руководство программиста
ГОСТ 19.505-79	Единая система программной документации. Руководство оператора . Требования к содержанию и оформлению
ГОСТ 19.506-79	Единая система программной документации. Описание языка . Требования к содержанию и оформлению
ГОСТ 19.507-79	Единая система программной документации. Ведомость эксплуатационных документов
ГОСТ 19.508-79	Единая система программной документации. Руководство по техническому обслуживанию. Требования к содержанию и оформлению
ГОСТ 19.601-78	Единая система программной документации. Общие правила дублирования, учета и хранения
ГОСТ 19.602-78	Единая система программной документации. Правила дублирования, учета и хранения программных документов, выполненных печатным способом
ГОСТ 19.603-78	Единая система программной документации. Общие правила внесения изменений
ГОСТ 19.604-78	Единая система программной документации. Правила внесения изменений в программные документы, выполненные печатным способом

Приобретение стандартов

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

Единая система программной документации	ГОСТ 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. Программный документ может быть представлен на различных типах носителей данных.

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

• титульной;
• информационной;
• основной;
• регистрации изменений.

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

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

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

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

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

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

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

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

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

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

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

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

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.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. Программный документ может быть представлен на различных типах носителей данных.

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

титульной;

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

основной;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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)