6 Требования к оформлению текстового документа
6.1 Оформление пояснительной записки. Общие требования
Текст пояснительной записки при необходимости разделяют на разделы и подразделы. Содержание разделов определяется предметной комиссией.
Разделы должны иметь порядковые номера в пределах всего документа, обозначенные арабскими цифрами без точки и записанные с абзацного отступа. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. В конце номера подраздела точка не ставится. Разделы, как и подразделы, могут состоять из одного или нескольких пунктов.
П р и м е р:
3 Правила оформления проекта
3.1 Общие требования
3.1.1
3.1.1.1
3.2 Нумерация
3.3 Рисунки
Внутри пунктов могут быть приведены перечисления. Перед каждой позицией перечисления следует ставить дефис или при необходимости ссылки в тексте документа на одно из перечислений строчную букву, после которой ставится скобка. Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, а запись производится с абзацного отступа, как показано в примере.
П р и м е р:
а)____________
б)____________
1)_________
2)_________
в)____________
Каждый раздел текстового документа необходимо начинать с нового листа (страницы).
6.2 Изложение текста документов
Полное наименование проекта на титульном листе, в основной надписи и при первом упоминании в тексте документа должно быть одинаковым с наименованием его в основном конструкторском документе.
В последующем тексте допускается употреблять сокращенное наименование проекта.
Наименования, приводимые в тексте документа и на иллюстрациях, должны быть одинаковыми.
Текст документа должен быть кратким, четким и не допускать различных толкований; технически и стилистически грамотным. Не допускается дословное воспроизведение текста из литературных источников, не рекомендуется обширное описание общеизвестных материалов. Достаточно привести техническую характеристику и принципиальные особенности, имеющие значение для проекта.
При повторном определении тех или иных параметров и величин допускается приводить лишь конечные результаты со ссылкой на методику их получения или сводить в таблицу.
При изложении обязательных требований в тексте должны применяться слова «должен», «следует», «необходимо», «требуется», «чтобы», «разрешается только», «не допускается», «запрещается», «не следует». При изложении других положений следует применять слова «как правило», «допускается», «рекомендуется», «при необходимости», «может быть», «в случае» и т.д.
Слова «как правило» означают, что данное требование является преобладающим, а отступление от него должно быть обосновано. Слово «допускается» означает, что данное решение применяется в виде исключения как вынужденное. Слово «рекомендуется» означает, что данное решение является одним из лучших, но оно не обязательно.
В документах должны применяться научно–технические термины, обозначения и определения, установленные соответствующими стандартами, а при их отсутствии – общепринятые в научно–технической литературе.
В тексте документа не допускается:
применять обороты разговорной речи, техницизма, профессионализма;
применять для одного и того же понятия синонимы, а также иностранные слова и термины при наличии их в русском языке;
применять сокращения слов, кроме установленных правилами русской орфографии, в соответствии с государственными стандартами;
сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковинках таблиц и в расшифровках буквенных обозначений, входящих в формулы и рисунки.
В тексте документа, за исключением формул, таблиц и рисунков, не допускается:
применять математический знак минус (–) перед отрицательными значениями величин (следует писать слово «минус»);
применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»);
применять без числовых значений математические знаки, а также знаки № (номер), % (процент);
применять индексы стандартов и других документов без регистрационного номера.
Наименование команд, режимов, сигналов и т.п. в тексте следует выделять кавычками, например, «Сигнал + 27 включено».
Перечень допускаемых сокращений слов для основных надписей, технических требований, таблиц, чертежей и спецификаций установлен ГОСТ 2.316–68.
Условные буквенные обозначения или знаки должны соответствовать принятому действующему законодательству и государственным стандартам.
В документе следует применять стандартизованные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417–81.
Наряду с единицами СИ при необходимости в скобках указывают единицы ранее применявшихся систем, разрешенных к применению. Применение в одном документе разных систем обозначения физических величин не допускается.
В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счета следует писать цифрами, а числа без обозначения единиц физических величин и единиц счета от единицы до девяти – словами.
П р и м е р ы:
1) Ток в первой ветви 5А.
2) Отобрать шесть труб длинной 17м для испытаний на давление.
Если в тексте документа приводят диапазон числовых значений физической величины, то обозначение единицы физической величины указывается после последнего числового значения диапазона.
П р и м е р:
От 10 до 20 кВ.
Приводя наибольшие или наименьшие значения величин, следует применять словосочетание «должно быть не более (не менее)».
Формулы в машинописный текст вносятся от руки. В документах, издаваемых нетипографским способом, формулы могут быть выполнены машинописным или чертежным шрифтом высотой не менее 2,5 мм.
В формулах в качестве символов следует применять обозначения, установленные соответствующими государственными стандартами.
Пояснения символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Пояснения каждого символа следует давать с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова «где» без двоеточия после него.
П р и м е р:
I=U / R , А (1)
где U – напряжение на участке цепи, В;
R – сопротивление участка цепи, Ом.
Применение машинописных и рукописных символов в одной формуле не допускается. Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.
Переносить формулы на следующую строку допускается только с помощью знаков выполняемых операций, причем знак в начале следующей строки повторяют. При переносе формулы на знаке умножения применяют знак «*».
Формулы должны нумероваться сквозной нумерацией арабскими цифрами, которые записывают на уровне формулы справа в круглых скобках. Одну формулу обозначают (1). Допускается нумерация формул в пределах разделов, в этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой (3.1).
Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например, формула (В.1).
Порядок изложения в документах математических уравнений такой же, как и формул.
6.3 Оформление иллюстраций и приложений
Количество иллюстраций должно быть достаточно для пояснения излагаемого текста. Иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его. Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД. Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией (Рисунок 1).
Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрами обозначения приложения «Рисунок А.3»
При ссылках на иллюстрации следует писать «... в соответствии с рисунком 2». Иллюстрации при необходимости могут иметь наименования и пояснительные данные (подрисуночный текст). Слово «Рисунок» и его наименование помещают после пояснительных данных и располагают следующим образом:
Рисунок 2 – Амперметр
Если в тексте документа имеется иллюстрация, на которой изображены составные части изделия, то на этой иллюстрации должны быть указаны номера позиций этих составных частей, которые располагают в возрастающем порядке, за исключением повторяющихся позиций. Указанные данные на иллюстрациях наносят согласно ГОСТ 2.109–73.
На приводимых в документе электрических схемах около каждого элемента указывают его позиционное обозначение (по стандарту) и при необходимости номинальное значение величины.
Материал, дополняющий текст документа, допускается помещать в приложениях. Приложениями могут быть графический материал, таблицы большого формата, расчеты, описания аппаратуры и приборов, описания алгоритмов и т.д. Приложение оформляют как продолжение данного документа на последующих его листах.
Приложения могут быть обязательными и информационными. Информационные приложения могут быть рекомендуемого или справочного характера.
В тексте документа на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте документа.
Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «Приложение» и его обозначения, а под ним в скобках для обязательного приложения пишут слово «обязательное», а для информационного – «рекомендуемое» или «справочное».
Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой.
Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, Й, О, Ч, Ь, Ы, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность.
Допускается обозначение приложений буквами латинского алфавита, за исключением букв I, О. В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами. Если в документе одно приложение, оно обозначается «Приложение А».
Приложения, как правило, выполняют на листах формата А4. Допускается оформлять приложения на листах формата A3, А4 × 3 , А4 × 4, А2, А1 по ГОСТ 2.301–68.
Иллюстрации (чертежи, схемы, графики), таблицы, распечатки с ЭВМ, расположенные на отдельных листах, включаются в общую нумерацию страниц пояснительной записки. Если их формат больше А4, то его учитывают так же, как одну страницу.
Нумерация разделов, подразделов, пунктов и их заголовки в содержании и в тексте пояснительной записки должны полностью совпадать.
6.4 Построение таблиц
Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким. Слово «Таблица» следует помещать в верхнем левом углу. Название следует помещать над таблицей.
При переносе части таблицы на ту же или другие страницы название помещают только над первой частью таблицы.
Цифровой материал, как правило, оформляют в виде таблиц в соответствии с рисунком 1.
Рисунок 1
Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В.
На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера.
Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.
Таблицы слева, справа и снизу ограничивают линиями.
Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
Головка таблицы должна быть отделена линией от остальной части таблицы.
Высота строк таблицы должна быть не менее 8 мм.
Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости, в приложении к документу.
Допускается помещать таблицу вдоль длинной стороны листа документа.
Если строки или графы таблицы выходят за формат страницы, ее делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют ее головку и боковик. При делении таблицы на части допускается ее головку или боковик заменять соответственно номером граф и строк. При этом нумеруют арабскими цифрами графы и (или) строки первой части таблицы.
Слово «Таблица» указывают один раз слева над первой частью таблицы, над другими частями слова «Продолжение таблицы» не пишут.
Если в конце страницы таблица прерывается и ее продолжение будет на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу, допускается не проводить.
Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице, при этом повторяют головку таблицы в соответствии с рисунком:
Таблица ...
Диаметр стержня крепежной детали, мм
|
Масса 1000 шт. стальных шайб, кг
|
Диаметр стержня крепежной детали, мм
|
Масса 1000 шт. стальных шайб, кг
|
1,1
|
0,045
|
2,0
|
0,192
|
1,2
|
0,043
|
2,5
|
0,350
|
1,4
|
0,111
|
3,0
|
0,553
|
Графу «Номер по порядку» в таблицу включать не допускается. Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на них, при делении таблицы на части, а также при переносе части таблицы на следующую страницу.
При необходимости нумерации показателей, параметров или других данных порядковые номера следует указывать в первой графе (боковике) таблицы непосредственно перед их наименованием (рисунок 3). Перед числовыми значениями величин и обозначением типов, марок и т.п. порядковые номера не проставляют.
Таблица...
Наименование показателя
|
Значение
|
|
в режиме 1
|
в режиме 2
|
1 Ток коллектора, А
|
5, не менее
|
7, не более
|
2 Напряжение на коллекторе, В
|
–
|
–
|
3 Сопротивление нагрузки коллектора, Ом
|
–
|
–
|
Рисунок 3
Если все показатели, приведенные в графах таблицы, выражены в одной и той же единице физической величины, то ее обозначение необходимо помещать над таблицей справа, а при делении таблицы на части – над каждой ее частью.
Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными ГОСТ 2.321, или другими обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например, D – диаметр, Н – высота, L – длина.
Ограничительные слова «более», «не более», «менее», «не менее» и др. должны быть помещены в одной строке или графе таблицы с наименованием соответствующего показателя после обозначения его единицы физической величины, если они относятся ко всей строке или графе. При этом после наименования показателя перед ограничительными словами ставится запятая.
Если в графе таблицы помещены значения одной и той же физической величины, то обозначение единицы физической величины указывают в заголовке (подзаголовке) этой графы в соответствии с рисунком 4. Числовые значения величин, одинаковые для нескольких строк, допускается указывать один раз.
Таблица…
Тип изолятора
|
Номинальное напряжение, В
|
Номинальный ток, А
|
ПНР–6/400
|
|
400
|
ПНР–6/800
|
6
|
800
|
ПНР–6/900
|
|
900
|
Рисунок 4
Текст, повторяющийся в строках одной и той же графы и состоящий из одиночных слов, чередующихся с цифрами, заменяют кавычками. Если повторяющийся текст состоит из двух и более слов, при первом повторении его заменяют словами «То же», а далее – кавычками. Если предыдущая фраза является частью последующей, то допускается заменить ее словами «То же» и добавить дополнительные сведения.
При наличии горизонтальных линий текст необходимо повторять.
Заменять кавычками повторяющиеся в таблице цифры, математические знаки, знаки процента и номера, обозначение марок материалов и типоразмеров изделий, обозначения нормативных документов не допускается.
При указании в таблицах последовательных интервалов чисел, охватывающих все числа ряда, их следует записывать: «От ... до ... включ.», «Св. ... до ... включ.»
В интервале, охватывающем числа ряда, между крайними числами ряда в таблице допускается ставить тире:
Таблица...
Наименование материала
|
Температура плавления, К (° С)
|
Латунь
|
1 131 – 1 173 (858–900)
|
Сталь
|
1 573 – 1 673 (1 300–1 400)
|
Чугун
|
1 373 – 1 473 (1 100–1 200)
|
Интервалы чисел в тексте записывают со словами «от» и «до» (имея в виду «От ... до ... включительно»), если после чисел указана единица физической величины или числа, представляют безразмерные коэффициенты, или через дефис, если числа представляют порядковые номера.
Примеры
1) ... толщина слоя должна быть от 0,5 до 20 мм.
2) 7 – 12, рисунок 1 – 14
В таблицах при необходимости применяют ступенчатые полужирные линии для выделения диапазона, отнесенного к определенному значению, объединения позиций в группы и указания предпочтительных числовых значений показателей, которые обычно расположены внутри ступенчатой линии, или для указания, к каким значениям граф и строк относятся определенные отклонения:
Таблица ...
Наружный
|
Масса 1 м трубы, кг, при толщине стенки, мм
|
диаметр, мм
|
3,0
|
3,5
|
4,0
|
4,5
|
5,0
|
5,5
|
6,0
|
6,5
|
32
|
2,146
|
2,460
|
2,762
|
3,052
|
3,329
|
3,594
|
3,947
|
4,316
|
38
|
2,589
|
2,978
|
3,354
|
3,718
|
4,069
|
4,408
|
4,735
|
5,049
|
42
|
2,885
|
3,323
|
3,749
|
4,162
|
4,652
|
4,951
|
5,327
|
5,690
|
45
|
3,071
|
3,582
|
4,044
|
4,495
|
4,932
|
4,358
|
5,771
|
6,171
|
50
|
3,474
|
4,014
|
4,538
|
5,049
|
5,049
|
6,036
|
6,511
|
6,972
|
54
|
3,773
|
4,359
|
4,932
|
5,493
|
6,042
|
6,578
|
7,104
|
7,613
|
6.5 Сноски
Если необходимо пояснить отдельные данные, приведенные в документе, то эти данные следует обозначать надстрочными знаками сноски.
Сноски в тексте располагают с абзацного отступа в конце страницы, на которой они обозначены, и отделяют от текста короткой тонкой горизонтальной линией с левой стороны.
Знак сноски ставят непосредственно после того слова, числа, символа, предложения, к которому дается пояснение, и перед текстом пояснения.
Знак сноски выполняют арабскими цифрами со скобкой и помещают на уровне верхнего обреза шрифта.
П р и м е р: «... печатающее устройство 1) ...».
Нумерация сносок отдельная для каждой страницы.
Допускается вместо цифр выполнять сноски звездочками: *. Применять более четырех звездочек не рекомендуется.
6.6 Ссылки
В ТД приводят ссылки:
– на данную работу;
– на использованные источники.
При ссылках на данную работу указывают номера структурных частей текста, формул, таблиц, рисунков, чертежей и схем.
При ссылках на структурные части текста ТД указывают номера разделов (со словом «раздел»), подразделов, пунктов, подпунктов, например: «... в соответствии с разделом 2», «... согласно 3.1», «... по 3.1.1»
Ссылки в тексте на номер формулы дают в скобках, например: «... согласно формуле (1)», «... как следует из выражения (5)».
Ссылки в тексте на таблицы и иллюстрации оформляют по типу: «... в таблице 1, графа 4», «... (таблица 3)», «... (рисунок 11)», «... в соответствии с рисунком 2», «... как показано на рисунке 6».
Ссылки на чертежи и схемы, выполненные на отдельных листах делают с указанием обозначения, например: «... как показано на схеме КПК0. 21.02.0301. 00.000 СБ».
При ссылки в тексте на использованные источники следует приводить порядковые номера по списку использованных источников, заключенные в квадратные скобки, например: «... как указано в монографии [10], «... в работах [11,12]. При необходимости указывают номер раздела или страницу.
6.7 Сокращения
При многократном упоминании устойчивых словосочетаний в тексте ТД следует использовать аббревиатуры или сокращения.
При первом упоминании должно быть приведено полное название с указанием в скобках сокращенного названия аббревиатуры, например: «фильтр нижних частот (ФНЧ)»; «...дожимная насосная станция (ДНС)», а при последующих упоминаниях следует употреблять сокращенное название.
Расшифровку аббревиатур и сокращений, установленных стандартами (ГОСТ 2.316, ГОСТ 4.12) и правилами русской орфографии допускается не приводить, например: ЭВМ, НИИ, АСУ, с. (страница), т.е. (то есть) и др.
6.8 Оформление расчетов
Порядок изложения расчетов в ТД определяется характером рассчитываемых величин.
Расчеты в общем случае должны содержать:
эскиз или схему объекта расчета;
задачу расчета (с указанием, что требуется определить при расчете);
данные для расчета;
условия расчета;
расчет;
заключение.
Эскиз или схему допускается вычерчивать в произвольном масштабе, обеспечивающем четкое представление о рассчитываемом объекте.
Данные для расчета, в зависимости от их количества, могут быть изложены в тексте или приведены в таблице.
Заключение должно содержать выводы о соответствии объекта расчета требованиям, изложенным в задаче расчета, например:
«Заключение: заданные допуски на размеры составных частей позволяют обеспечить сборку изделия по методу полной взаимозаменяемости».
Все расчеты должны, как правило выполнятся в системе СИ.
Запись числовых расчетов выполняют, как правило, в следующем порядке:
формула;
знак = (равно);
подстановка числовых значений, величин и коэффициентов (как правило в основных единицах СИ);
результат с единицей физической величины.
П р и м е р:
Запись пункта расчета:
R=B/I=125/16*103 Ом =7,8*103 Ом=7,8 кОм (2)
6.9 Примечания
Примечания приводят в документах, если необходимы пояснения или справочные данные к содержанию текста, таблиц или графического материала.
Примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которой относятся эти примечания, и печатать с прописной буквы с абзаца. Если примечание одно, то после слова «Примечание» ставится тире и примечание печатается тоже с прописной буквы. Одно примечание не нумерует. Несколько примечаний нумеруют по порядку арабскими цифрами. Примечание к таблице помешают в конце таблицы над линией обозначающей окончание таблицы.
П р и м е р:
Примечание– _________________________________________________
_____________________________________________________________
Примечания
1________________________
2________________________
3________________________
|
