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

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

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

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

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

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

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

Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющими данными [из п. 2.3.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.6 ГОСТ 19.106-78]

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

Остальные перечни составляют в порядке возрастания номеров [из п. 1.7 ГОСТ 19.106-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]

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

• наименование министерства (ведомства);
• наименование документа;
• обозначение документа;
• сведения о носителе данных, на котором представляется подлинник;
• общее количество листов утверждения, объем документа;
• сведения о разработчике;
• подпись нормоконтролера;
• отметка об учете и хранении;
• сведения об изменении.

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