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

Наименования разделов и подразделов записывают в графу «Наименование» ведомостей документов или описи.

Вновь разработанные документы рекомендуется записывать в разделах, подразделах ведомости в порядке возрастания:

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

Заимствованные документы рекомендуется записывать в ведомости в конце каждого раздела, подраздела [из п. 3.1 ГОСТ 24.301-80]

Требования к построению и другие общие требования к заполнению граф должны соответствовать разд. 3 ГОСТ 2.105 [из п. 3.2 ГОСТ 24.301-80]

Ведомость технического проекта, ведомость рабочей документации, ведомость проекта выполняют в соответствии с разд. 4 ГОСТ 2.106 [из п. 3.3 ГОСТ 24.301-80]

Опись составляют при необходимости брошюрования документов в книгу, альбом, папку. Опись является первым документом книги, альбома, папки. Опись эксплуатационных документов выполняют в соответствии с разд. 3 ГОСТ 2.601. Прочие описи выполняют в соответствии с разд. 2 ГОСТ 2.105 [из п. 3.4 ГОСТ 24.301-80]

Таблицы и иллюстрации, помещаемые в документах, следует оформлять в соответствии с разд. 2 ГОСТ 2.105. Если иллюстрация помещена на двух или более листах, то на первом листе указывают номер иллюстрации и ее наименование, а на последующих - слово «продолжение» и номер иллюстрации, например: «Продолжение рис.1». Если иллюстрация в тексте одна, то слово «рис.» перед ее наименованием не пишут. Если такая иллюстрация помещена на нескольких листах, то на втором и последующих листах пишут «Продолжение».

При переносе части таблицы на следующий лист (страницу) ее головку или боковик допускается заменять соответственно номером граф и строк. При этом необходимо пронумеровать графы и строки первого листа таблицы [из п. 2.3.1 ГОСТ 24.301-80]

Оформление приложения должно соответствовать требованиям разд. 2 ГОСТ 2.105 с учетом требований п. 1.3 [из п. 2.3.2 ГОСТ 24.301-80]

Рисунки форм документов и видеокадров, включенных в текстовые документы, выполняют в соответствии с ГОСТ 24.304 [из п. 2.3.3 ГОСТ 24.301-80]

Документ (часть документа) включает:

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

[из п. 1.3.1 ГОСТ 24.301-80]

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

Титульный лист оформляют в соответствии с разд. 4 ГОСТ 2.105, за исключением поля 4, в котором помещают наименование части АСУ (системы, подсистемы и т.д.) и наименование документа (части документа).

Не допускается на заглавном и титульном листах повторять подписи одних и тех же должностных лиц. При отсутствии титульного листа первым листом документа является заглавный [из п. 1.3.2 ГОСТ 24.301-80]

Содержание приводят, если документ включает не менее двух разделов или один раздел и приложение при общем числе листов не менее 10, а также при наличии частей.

Содержание помещают на заглавном листе, продолжение содержания - на последующих листах.

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

Наименование разделов, подразделов, приложений в «Содержании» документа записывают с абзаца с прописной буквы, далее строчными буквами. Под словом «Лист» проставляют номера листов, с которых начинаются разделы, подразделы, приложения документа, заполняя промежуток от последней строки наименования до номера листа точками. Наименования разделов, подразделов приложений в «Содержании» должны совпадать с этими наименованиями в тексте [из п. 1.3.3 ГОСТ 24.301-80]

Структура и состав основного текста документа установлены в стандартах системы технической документации на АСУ, регламентирующих требования к содержанию документов [из п. 1.3.4 ГОСТ 24.301-80]

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

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

Список использованных источников составляют согласно ГОСТ 7.32. Список литературы составляют согласно разд. 2 ГОСТ 2.105.

При разделении документа на части допускается список литературы составлять для всего документа и помещать в последней части [из п. 1.3.6 ГОСТ 24.301-80]

Лист регистрации изменений включают в документы, состоящие более чем из 15 листов. Лист регистрации изменений включают в общее число листов документа и помещают последним [из п. 1.3.7 ГОСТ 24.301-80]

Изложение текста документа должно соответствовать требованиям разд. 2 ГОСТ 2.105 [из п. 2.2.1 ГОСТ 24.301-80]

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

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

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

Специальные знаки, формулы, буквы редко применяемых алфавитов допускается записывать от руки чернилами или тушью черного цвета [из п. 2.2.2 ГОСТ 24.301-80]

Знаки N, §, %, +, - и т.д. следует применять только при числовых значениях. В тексте эти знаки следует писать словами [из п. 2.2.3 ГОСТ 24.301-80]

Римские цифры следует употреблять только для обозначения сорта (категории) изделия, кварталов года, полугодия. В остальных случаях применяют арабские цифры [из п. 2.2.4 ГОСТ 24.301-80]

Цифровые обозначения дат и количественных числительных не должны иметь падежных окончаний. Если в документах приведен самостоятельный перечень символов и числовых коэффициентов, включенных в формулы, значения их под каждой формулой не приводят [из п. 2.2.5 ГОСТ 24.301-80]

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

Наименования единиц счета и измерений физических величин, употребляемые в тексте без числовых значений, следует записывать без сокращений (например: длина приведена в миллиметрах) [из п. 2.2.6 ГОСТ 24.301-80]

Пояснения к основному тексту, таблицам допускается оформлять сносками. Правила оформления сносок к таблицам - по ГОСТ 1.5.

Сноски к тексту обозначают подстрочными знаками звездочкой или цифрой со скобкой, например: комплекс^*, машина². В одном документе следует применять единую систему обозначения сносок. Если сноска относится к отдельному слову, знак сноски помещают непосредственно у этого слова, если к предложению, то в конце предложения. Текст сноски располагают в конце листа и отделяют от текста линией длиной 30 ... 40 мм, проведенной в левой части листа. Текст сноски выполняют машинописным способом через один интервал [из п. 2.2.7 ГОСТ 24.301-80]

Примечания к тексту, таблице, графическому материалу выполняют по ГОСТ 1.5.

Примечания к таблицам, расположенным вдоль длинной стороны формата, помещают вдоль длинной стороны. В случае, если текст примечания переносится на следующий лист, то его допускается выполнять вдоль короткой стороны. Текст примечаний выполняют машинописным способом через один интервал [из п. 2.2.8 ГОСТ 24.301-80]