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

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

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

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

Лист утверждения

Лист утверждения (ЛУ) выпускается на каждый программный документ на листах бумаги формата А4 .
Обозначение листа утверждения состоит из обозначения документа, к которому относится ЛУ, и через дефис - шифра ЛУ.
ЛУ не входит в общее число листов документа.
ЛУ вносят в спецификацию после утвержденного документа и хранят на предприятии - держателе подлинника документа. Лист утверждения спецификации также вносят в данную спецификацию.
ЛУ заполняют по форме, приведенной на чертеже ниже:

• Поле 1 - наименование министерства или ведомства, в систему которого входит организация, разработавшая данный документ, заполняется по требованию заказчика. Выше поля 1, в правом верхнем углу, при необходимости, ставят специальную отметку (гриф секретности, указание "С предприятия не выносить" и т.п.).
• Поле 2 - в левой части поля - должности и подписи лиц, согласовавших документ от организации заказчика при необходимости, в правой части поля - должность и подпись лица, утвердившего документ от организации разработчика. Справа от каждой подписи - инициалы и фамилия лица, подписавшего документ, а ниже подписи - дата подписания.
• Поле 3 - полное наименование программы или программного изделия.
• Поле 4 - обозначение документа и указание вида носителя данных (для документов на носителе данных).
• Поле 5 - общее количество листов утверждения, например, "Листов 3". (Для одного листа поле не заполняется);
• Поле 6 - в правой части поля - должности и подписи руководителей организации, выпустившей документ, руководителя разработки, исполнителей разработки документа и нормоконтроллера. Справа от каждой подписи - инициалы и фамилия лица, подписавшего документ, а ниже подписи - дата подписания.
• Поле 7 - год издания документа.
• Поле 8 - отметка об учете и хранении.
• Поле 9 - строка изменений.
• Поле 10 - литера документа.

Пример заполнения ЛУ показан ниже:

Титульный лист

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

• Поле 1 - заполняется по требованию заказчика;
• Поле 2 - не заполняется.
• Поля 3,4 - как в ЛУ.
• Поле 5 - указывают объем документа;
• поле 6 - не заполняют;
• Поля 7-10 - как в ЛУ.

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

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

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

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

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

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

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

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

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

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

• титульная часть
  • лист утверждения (не входит в общее количество листов документа);
  • титульный лист (первый лист документа);
• информационная часть;
  • аннотация;
  • лист содержания;
• основная часть;
  • текст документа (с рисунками, таблицами и т..п.);
  • приложения; ¹⁾
  • перечень терминов; ^{1) 2)}
  • перечень сокращений; ^{1) 2)}
  • перечень рисунков; ^{1) 3)}
  • перечень таблиц; ^{1) 3)}
  • предметный указатель; ^{1) 2)}
  • перечень ссылочных документов; ¹⁾
  • перечень символов и числовых коэффициентов; ^{1) 2)}
  • часть регистрации изменений;
  • лист регистрации изменений.

¹⁾ Включается в документ при необходимости
²⁾ Составляется в алфавитном порядке
³⁾ Составляется в порядке возрастания номеров

Общие требования к оформлению

При выполнении программного документа машинописным или машинным способом документ выполняется на одной стороне листа, с такими интервалы между строк, которые обеспечивают пригодность к микрофильмированию
При выполнении типографским способом документ выполняется в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом
При выполнении части рукописным способом - на одной стороне листа, черными чернилами или тушью, чертежным шрифтом с высотой букв не менее 2,5 мм.
При выполнении программного документа машинописным, машинным или рукописным способами разрешается вписывать в документы отдельные слова, формулы, условные знаки и т.п., а также исправлять опечатки и графические неточности от руки чертежным шрифтом.

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

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

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

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

Форма 1

Форма 2

• Поле 1 - порядковый номер страницы.
• Поле 2 - обозначение документа.
• Поле 3 - текст документа.
• Поле 4 - строка изменений.

Рамку формата можно не наносить.

Аннотацию размещают на отдельной пронумерованной странице с заголовком "АННОТАЦИЯ", но не нумеруют как раздел. В аннотации указывают издание программы, кратко излагают назначение и содержание документа, общее количество частей документа (если их больше одной).

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

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

• Раздел - первая ступень деления, обозначенная номером и снабженная заголовком.
• Подраздел - часть раздела, обозначенная номером и имеющая заголовок.
• Пункт- часть раздела или подраздела, обозначенная номером. Может иметь заголовок.
• Подпункт- часть пункта, обозначенная номером. Может иметь заголовок.
• Внутри подразделов, пунктов, подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефиса перед текстом. Не рекомендуется делать ссылки на элементы перечисления.
• Абзац - логически выделенная часть текста, не имеющая номера.

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

Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой. В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой (2.1, 3..1 и т.д.).
При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Ниже приведен пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов:

Текст документа

Текст документа должен быть кратким, четким, исключающим возможность неоднозначного толкования.
Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
Для выделения основных понятий допускается изменять интервалы между словами, а также печатать отдельные слова и части текста шрифтом, отличным от печати основного текста,
Необходимые пояснения к тексту документа могут оформляться сносками. Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего образа шрифта, например, "печатающее устройство²⁾".

Иллюстрации

Иллюстрации могут быть расположены в тексте документа и/или в приложениях. Иллюстрации нумеруются арабскими цифрами в пределах всего документа. В приложениях иллюстрации нумеруются в пределах приложения.
Ссылки на иллюстрации дают по типу: "рис.2" или "(рис.2)". Ссылки на ранее упомянутые иллюстрации дают по типу: "см. рис.2".
Иллюстрации могут иметь наименование и подрисуночный текст, поясняющий содержание иллюстрации. Наименование помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющим текстом.

Формулы

Формулы в документе нумеруются арабскими цифрами , номер ставят с правой стороны страницы, в скобках, на уровне формулы. В пределах всего документа или его частей формулы имеют сквозную нумерацию.
Ссылки в тексте на порядковый номер формулы дают в скобках, например: "в формуле (3)".
Значения символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова "где", без двоеточия после него.
Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения их под формулой допускается не приводить.
Размерность одного и того же параметра в пределах одного документа должна быть постоянной.

Ссылки

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

Таблицы

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

Примечания

В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
Одно примечание не нумеруется. После слова "Примечание" ставят точку. Несколько примечаний нумеруют по порядку арабскими цифрами с точкой. После слова "Примечания" ставят двоеточие.

Сокращения

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

Приложения

В виде приложений можно оформлять иллюстративный материал, таблицы или текст вспомогательного характера. Приложения могут быть продолжением данного документа на последующих страницах или выпускаться в виде отдельного документа. Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.
Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "ПРИЛОЖЕНИЕ" прописными буквами и иметь тематический заголовок При наличии в документе более одного приложения все приложения нумеруют в арабскими цифрами (без знака ╧).
Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты, нумеруемые отдельно по каждому приложению. Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения.
На приложения должны быть даны ссылки в основном тексте документа. Все приложения должны быть перечислены в листе "Содержание".