Обозначение программ и программных документов. ГОСТ 19.103 - 77
ГОСТ 19.103-77 устанавливает структуру обозначения программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Проще говоря, данный ГОСТ описывает каким должен быть шифр документа вида А.В.ХХХХХ-ХХ ХХ ХХ-Х, и что означает каждое поле данного шифра.
Основные надписи. ГОСТ 19.104 - 78
ГОСТ 19.104-78 устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах, предусмотренных стандартами ЕСПД, независимо от способа их выполнения.
В ГОСТе есть примеры титульного листа и листа утверждения, а также общая форма листа, разбитая на поля. Также можно посмотреть пример.
Требования к программным документам, выполненным печатным способом. ГОСТ 19.106 - 78
ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.
Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".
Материалы программного документа должны располагаться в следующей последовательности:
§ Титульная часть:
§ лист утверждения (не входит в общее количество листов документа);
§ титульный лист (первый лист документа);
§ Информационная часть:
§ аннотация;
§ лист содержания;
§ Основная часть:
§ текст документа (с рисунками, таблицами и т.п.);
§ приложения;
|
|
|
§ перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
§ часть регистрации изменений:
§ лист регистрации изменений.
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
Форматирование текста:
§ Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
§ Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
§ Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
§ Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
§ Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
§ Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
|
|
|
§ при выполнении документа машинописным способом - двум интервалам.
§ Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
§ при выполнении документа машинописным способом - трём машинописным интервалам.
§ Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
§ В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
§ Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
§ При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
§ Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
§ Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
|
|
|
§ Необходимые пояснения к тексту документа могут оформляться сносками.
§ Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
§ Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
§ Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
§ Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
§ Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
§ В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
|
|
|
§ Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
§ В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
§ Одно примечание не нумеруется. После слова «Примечание» ставят точку.
§ Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
§ Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
§ Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
§ Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.
В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.
Дата добавления: 2021-03-18; просмотров: 163; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!