1 Основополагающие стандарты ЕСПД

Основные надписи в тексте документа [из разд. 4 ГОСТ 19.104-78]

Основные надписи в тексте документа [из разд. 4 ГОСТ 19.104-78]

Содержание и правила выполнения основных надписей в программных документах на конкретных носителях данных приведены в соответствующих государственных стандартах ЕСПД [из п. 4.1 ГОСТ 19.104-78]

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

Основные надписи листа утверждения (ЛУ) [из разд. 2 ГОСТ 19.104-78]

Основные надписи листа утверждения (ЛУ) [из разд. 2 ГОСТ 19.104-78]

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

Обозначение листа утверждения состоит из обозначения документа, к которому относится лист утверждения, и через дефис - шифра ЛУ.

Лист утверждения не входит в общее количество листов документа [из п. 2.2 ГОСТ 19.104-78]

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

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

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

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

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

По особому разрешению заказчика лист утверждения может быть выслан и в другие организации [из п. 2.4 ГОСТ 19.104-78]

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

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

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

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

Пример заполнения ЛУ приведен в приложении 2. Количество подписей в приложении приведено условно [из п. 2.5 ГОСТ 19.104-78]

Основные надписи титульного листа [из разд. 3 ГОСТ 19.104-78]

Основные надписи титульного листа [из разд. 3 ГОСТ 19.104-78]

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

[из п. 3.1 ГОСТ 19.104-78]

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

__Утвержден___

обозначение ЛУ

Пример заполнения титульного листа приведен в приложении 3 [из п. 3.2 ГОСТ 19.104-78]

Основные положения [из разд. 1 ГОСТ 19.104-78]

Основные положения [из разд. 1 ГОСТ 19.104-78]

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

[из п. 1.1 ГОСТ 19.104-78]

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

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

Настоящий стандарт устанавливает структуру обозначения программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения [из п. 1 ГОСТ 19.103-77]

Обозначение программ и документов должно состоять из групп знаков, разделенных точками (после кода страны и кода организации-разработчика), пробелами (после номера редакции документа и кода вида документа), дефисами (после регистрационного номера и номера документа данного вида) [из п. 2 ГОСТ 19.103-77]

Устанавливается регистрационная система обозначения программ и программных документов.

Структура обозначения программы и ее программного документа - спецификации:

- Структура обозначения программы и ее программного документа - спецификации

[из п. 3 ГОСТ 19.103-77]

Структура обозначения других программных документов:

- Структура обозначения других программных документов

[из п. 4 ГОСТ 19.103-77]

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

Регистрационный номер присваивают в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом, в установленном порядке.

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

Номер издания программы или номер редакции документа присваивают в порядке возрастания с 01 до 99 [из п. 5 ГОСТ 19.103-77]

Код вида документа присваивают в соответствии с требованиями ГОСТ 19.101-77 [из п. 6 ГОСТ 19.103-77]

Номер документа данного вида присваивают в порядке возрастания с 01 до 99 [из п. 7 ГОСТ 19.103-77]

Номер части одного и того же документа присваивают в порядке возрастания с 1 до 9.

Примечание - Если документ состоит из одной части, то дефис и порядковый номер части не указывают [из п. 8 ГОСТ 19.103-77]

Номер редакции спецификации и ведомости эксплуатационных документов на программу должен совпадать с номером издания этой же программы [из п. 9 ГОСТ 19.103-77]

Иллюстрации [из подр. 2.3 ГОСТ 19.106-78]

Иллюстрации [из подр. 2.3 ГОСТ 19.106-78]

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

Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.

В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документ.

Ссылки на иллюстрации дают по типу: «рис. 12» или «(рис. 12)».

Ссылки на ранее упомянутые иллюстрации дают с сокращенным словом «смотри», например, «см. рис.12».

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

Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющими данными [из п. 2.3.1 ГОСТ 19.106-78]

Общие требования [из разд. 1 ГОСТ 19.106-78]

Общие требования [из разд. 1 ГОСТ 19.106-78]

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

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

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

Примечания:

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

[из п. 1.2 ГОСТ 19.106-78]

Вписывать в программные документы, выполненные машинописным, машинным и рукописным способами, отдельные слова, формулы, условные знаки (oт руки чертежным шрифтом), буквы латинского и греческого алфавитов, а также выполнять схемы и рисунки необходимо черными чернилами или тушью [из п. 1.3 ГОСТ 19.106-78]

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

Повреждения листов документов, помарки и следы не полностью удаленного прежнего текста (графики) не допускаются [из п. 1.4 ГОСТ 19.106-78]

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

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

[из п. 1.5 ГОСТ 19.106-78]

- Форма 1 ГОСТ 19.106-78

- Форма 2 ГОСТ 19.106-78

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

Приложения, перечни терминов, сокращений, рисунков и таблиц, предметный указатель, перечни ссылочных документов, символов и числовых коэффициентов выполняются при необходимости [из п. 1.6 ГОСТ 19.106-78]

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

Остальные перечни составляют в порядке возрастания номеров [из п. 1.7 ГОСТ 19.106-78]

Построение документа [из подр. 2.1 ГОСТ 19.106-78]

Построение документа [из подр. 2.1 ГОСТ 19.106-78]

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

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

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

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

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

Лист утверждения выпускают на весь документ с обозначением первой части [из п. 2.1.1 ГОСТ 19.106-78]

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

  • поле 1 - порядковый номер страницы;
  • поле 2 - обозначение документа;
  • поле 3 - текст документа;
  • поле 4 - строка изменений; заполняется в соответствии с требованиями ГОСТ 19.604-78.

Рамку (границы) формата страниц документа допускается не наносить [из п. 2.1.2 ГОСТ 19.106-78]

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

В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей [из п. 2.1.3 ГОСТ 19.106-78]

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

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

Наименования, включенные в содержание, записывают строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры [из п. 2.1.4 ГОСТ 19.106-78]

Текст каждого документа, при необходимости, разбивают на пункты, а пункты - на подпункты, независимо от того, разделен документ на части, разделы и подразделы или нет [из п. 2.1.5 ГОСТ 19.106-78]

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

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

Подраздел - часть раздела, обозначенная номером и имеющая заголовок.

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

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

Абзац - логически выделенная часть текста, не имеющая номера.

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

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

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

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

Каждый структурный элемент начинается с абзацного отступа [из п. 2.1.6 ГОСТ 19.106-78]

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

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

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

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

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

Каждый раздел рекомендуется начинать с нового листа [из п. 2.1.7 ГОСТ 19.106-78]

Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела, должно быть равно:

  • при выполнении документа машинописным способом - двум интервалам;
  • при выполнении рукописным способом - 10 мм;
  • при выполнении машинным способом - не менее трех высот шрифта.

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

  • при выполнении документа машинописным способом - трем машинописным интервалам;
  • при выполнении рукописным способом - не менее 15 мм;
  • при выполнении машинным способом - не менее четырех высот шрифта.

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

При типографском способе издания документов указанные расстояния оформляют по правилам для типографских изданий [из п. 2.1.8 ГОСТ 19.106-78]

Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.

Разделы должны иметь порядковый номер (1, 2 и т.д.).

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

Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой (2.1, 3.1 и т.д.).

При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т. д.).

Пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов приведен в справочном приложении 2 [из п. 2.1.9 ГОСТ 19.106-78]

Страницы

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. +7(967) 044-84-77 или в форме Контакты.

Copyright © «Техническая документация» 2008. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика