оформление программного кода в соответствии с гост

Оформление программного кода в соответствии с гост

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

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

Unified system for program documentation. General requirements for program documents

Дата введения 1980-01-01

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

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

Электронный текст документа

подготовлен АО «Кодекс» и сверен по:

Единая система программной документации:

Источник

Оформление программного кода в соответствии с гост

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

Требования к содержанию и оформлению

Unified system for program documentation. Specification. Requirements to contents and form of presentation

Дата введения 1980-01-01

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

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

1. Настоящий стандарт устанавливает форму и порядок составления программного документа «Спецификация», определенного ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2090-80*.

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

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

Информационную часть (аннотацию и содержание) допускается в документ не включать.

3. Спецификация является основным программным документом для компонентов, применяемых самостоятельно, и для комплексов.

Для компонентов, не имеющих спецификации, основным программным документом является «Текст программы».

Форма спецификации приведена в приложении.

4. Спецификация в общем случае должна содержать разделы:

Наименование каждого раздела указывают в виде заголовка в графе «Наименование». Для документов, выполненных печатным способом, заголовок подчеркивают.

5. В раздел «Документация» вносят программные документы на данную программу, кроме спецификации и технического задания, в порядке возрастания кода вида документа, входящего в обозначение.

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

3-5. (Измененная редакция, Изм. N 1).

6. После каждого раздела спецификации необходимо оставлять несколько свободных строк для дополнительных записей.

7. Графы спецификаций заполняют следующим образом: в графе «Обозначение» указывают:

в графе «Наименование» указывают:

При отсутствии места в графе «Примечание» допускается записывать только порядковые номера примечаний. Текст примечаний записывают в конце соответствующих разделов спецификации. Допускается текст примечаний записывать на последних листах спецификации на листах без граф с проставлением порядкового номера примечания.

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

8. В графе «Обозначение» запись производят в одну строку. В остальных графах спецификации записи допускаются в несколько строк.

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

ПРИЛОЖЕНИЕ
Обязательное

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

Электронный текст документа

подготовлен АО «Кодекс» и сверен по:

Единая система программной документации:

Источник

Оформление программного кода в соответствии с гост

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

Требования к содержанию и оформлению

Unified system for program documentation. Text of program. Requirements for contents and form of presentation

Дата введения 1980-01-01

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

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в марте 1983 г. (ИУС 7-83).

1. Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Текст программы», определенного ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 3746-82*.

2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

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

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

3. Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.

Допускается вводить наименование также и для совокупности разделов.

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

символическая запись на исходном языке;

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

символическое представление машинных кодов и т.п.

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

Электронный текст документа

подготовлен АО «Кодекс» и сверен по:

Единая система программной документации:

Источник

Оформление программного кода в соответствии с гост

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.1.2. Информационная и основная части программного документа выполняются по форме 1 или 2, где:

Рамку (границы) формата страниц документа допускается не наносить.

2.1.3. Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.

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

2.1.4. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.

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

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

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

2.1.6. Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.

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

Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.

Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефиса перед текстом.

Не рекомендуется делать ссылки на элементы перечисления.

Каждый структурный элемент начинается с абзацного отступа.

2.1.7. Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.

Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).

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

Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят. Если заголовок состоит из двух предложений, их разделяют точкой.

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

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

Источник

Оформление программного кода в соответствии с гост

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

Unified system for program documentation. Basic legends

Дата введения 1980-01-01

Постановлением Государственного комитета CCCР по стандартам от 18 декабря 1978 г. N 3351 дата введения установлена 01.01.80

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г., Пост. N 4150 от 07.09.81 (ИУС 11-81).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Заполняют по требованию заказчика.

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

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

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

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

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

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

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

Форма листа утверждения

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

2.2.-2.5. (Измененная редакция, Изм. N 1).

3. ОСНОВНЫЕ НАДПИСИ ТИТУЛЬНОГО ЛИСТА

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

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

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

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

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

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

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

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

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
Справочное

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

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

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

ПРИЛОЖЕНИЯ 1-3. (Введены дополнительно, Изм. N 1).

Электронный текст документа

подготовлен АО «Кодекс» и сверен по:

Единая система программной документации:

Источник