Построение текста пояснительной записки

7.2.1 Текст пояснительной записки следует делить на разделы, подразделы, пункты. Пункты, при необходимости, могут быть разделены на подпункты.

7.2.2 Каждый раздел текста рекомендуется начинать с новой страницы.

7.2.3 Разделы должны иметь порядковые номера в пределах ПЗ, обозначенные арабскими цифрами и записанные с абзацного отступа. Подразделы должны иметь нумерацию в пределах каждого раздела, пункты в пределах подраздела, подпункты - в пределах пункта.

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

Пример –

1 Типы и размеры (Номер и заголовок первого раздела)

.....................................................................................

2 МЕТОДЫ ИСПЫТАНИЙ (Номер и заголовок второго раздела)

2.1 Периодические колебания (Номер и заголовок первого подраздела-второго раздела)

2.1.2.1 2.1.2.2

Нумерация подпунктов второго пункта первого подраздела второго раздела документа

7.2.4 Внутри разделов, подразделов, пунктов или подпунктов могут быть приведены перечисления.

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

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

Пример -

а) _________

б) _________

1) _______

2) _______

в) __________

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

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

Заголовки

7.3.1 Разделы, подразделы должны иметь заголовки. Пункты заголовков могут не иметь.

Заголовки должны четко и кратко отражать содержание разделов, подразделов, пунктов.

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

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

7.4 Требования к тексту пояснительной записки

7.4.1 В ПЗ должны применяться термины, обозначения и определения, установленные стандартами по соответствующему направлению науки, техники и технологии, а при их отсутствии - общепринятые в научно-технической литературе.

7.4.2 В ПЗ не допускается:

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

- применять произвольные словообразования;

- применять индексы стандартов (ГОСТ, ГОСТ Р, ОСТ и т.п.), технических условий (ТУ), строительных норм и правил (СНиП) и других документов без регистрационного номера;

- использовать в тексте математические знаки и знак Æ (диаметр), а также знаки № (номер) и % (процент) без числовых значений. Следует писать: «температура 20 °С»; «номер опыта» (но не «№ опыта»); «влажность 98 %», «процент выхода» (но не «% выхода»).

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

7.4.4 В ПЗ следует применять стандартизированные единицы физических величин, их наименования и обозначения.

Построение таблиц

7.5.1 Таблицы применяют для лучшей наглядности и удобства сравнения показателей и, как правило, оформляются в соответствии с рисунком 1.

7.5.2 Таблица помещается в тексте сразу же за первым упоминанием о ней или на следующей странице.

7.5.3 Таблицы, за исключением приведенных в приложении, нумеруются в пределах каждого раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы в пределах раздела, разделенных точкой. Допускается сквозная нумерация таблиц арабскими цифрами по всему ПЗ. Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения.

Если в тексте одна таблица, то она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В.

7.5.4 Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким. Название таблицы помещают над таблицей после ее номера через тире, с прописной буквы (остальные строчные), без абзацного отступа. Надпись «Таблица...» пишется над левым верхним углом таблицы и выполняется строчными буквами (кроме первой прописной) без подчеркивания (рисунок 1).

Рисунок 1- Пример оформления таблицы

7.5.5 Заголовки граф таблицы выполняют с прописных букв, а подзаголовки - со строчных, если они составляют одно предложение с заголовком, и с прописной - если они самостоятельные. В конце заголовка и подзаголовка знаки препинания не ставятся. Заголовки указываются в единственном числе. Допускается применять размер шрифта в таблице меньший, чем в тексте. Диагональное деление головки таблицы не допускается.

7.5.6 Таблицу с большим количеством строк допускается переносить на другую страницу. При переносе части таблицы на другую страницу заголовок помещают только перед первой частью таблицы, над другими частями справа пишется слово «Продолжение» и указывается порядковый номер таблицы, например: «Продолжение таблицы 2.7». Нижнюю горизонтальную черту, ограничивающую таблицу, не проводят.

7.5.7. Таблицы с большим количеством граф допускается делить на части и помещать одну под другой на одном листе. Над последующими частями таблиц указывается слово: «Продолжение», а при наличии нескольких таблиц в ПЗ указывается номер таблицы, например: «Продолжение таблицы 2.3».

7.5.8 Если строки и графы таблицы выходят за формат страницы, то в первом случае в каждой части таблицы повторяется головка, во втором случае – боковик.

7.5.9 Если цифровые данные в пределах графы таблицы выражены в одних единицах физической величины, то они указываются в заголовке каждой графы в соответствии с рисунком 2. Включать в таблицу отдельную графу «Единицы измерений» не допускается. Числовые значения величин, одинаковые для нескольких строк, допускается указывать один раз в соответствии с рисунком 2 (графы L₁, L₂, L₃).

Таблица 6.1 – ………………

В миллиметрах

Масса, кг, не более	Длина, мм	L1	L2	L3

Рисунок 2 – Пример оформления таблицы с буквенными обозначениями

в заголовках граф

Допускается в заголовках и подзаголовках граф отдельные понятия заменять буквенными обозначениями, но при условии, чтобы они были установлены стандартами, либо пояснены в тексте, например: D - диаметр, H - высота. Показатели с одним и тем же буквенным обозначением группируют последовательно в порядке возрастания индексов в соответствии с рисунком 2.

7.5.10 Обозначение единицы физической величины, общей, для всех данных в строке, следует выносить в боковик таблицы в соответствии с рисунком 3.

Таблица 6.2 - Основные характеристики прибора

Наименование параметра	Норма для типа
Р - 25	Р - 75	Р-150
1 Максимальная пропускная способность, л/мин, не более
2 Масса, кг, не более

Рисунок 3- Пример оформления таблиц с нумерацией граф

7.5.11 Слова «более», «не более», «менее», «не менее», «в пределах» и другие ограничительные слова следует помещать в боковике таблицы рядом с наименованием соответствующего параметра, после обозначения единицы физической величины и отделять запятой в соответствии с рисунком 3.

7.5.12 Не допускается включать в таблицу графу «№ п/п».

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

7.5.14 Повторяющийся в графе таблицы текст, состоящий из одного слова, допускается заменять кавычками, если строки в таблице не разделены линиями. Если повторяющийся текст состоит из двух и более слов, то при первом повторении его заменяют словами «То же» и далее кавычками в соответствии с рисунком 4.

Таблица 6.3 – Основные требования к продукции

 

Наименование отливки	Положение оси вращения
Гильза цилиндрическая	Горизонтальное
То же	«
«	«

Рисунок 4 - Пример оформления таблиц с повторяющимся текстом

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

Если цифровые или иные данные в таблице не приводятся, то в графе ставится прочерк.

Иллюстрации

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

Все иллюстрации именуются в тексте рисунками и нумеруются в пределах каждого раздела. Номер иллюстрации составляется из номера раздела и порядкового номера иллюстрации в пределах данного раздела, разделенных точкой, например: «рисунок 5.1» (первый рисунок пятого раздела). Допускается сквозная нумерация рисунков арабскими цифрами по всему ПЗ. Если рисунок один, то он обозначается «Рисунок 1». Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например, «Рисунок А.3.».

На все иллюстрации должны быть даны ссылки в ПЗ. При ссылках на иллюстрации следует писать «… в соответствии с рисунком 2» при сквозной нумерации и «… в соответствии с рисунком 1.2» при нумерации в пределах раздела.

7.6.2 Иллюстрации, помещаемые в отчете, должны соответствовать требованиям государственных стандартов Единой системы конструкторской документации (ЕСКД) и системы проектной документации для строительства (СПДС).

7.6.3 Иллюстрация располагается по тексту документа, если она размещается на листе формата А4. Если формат иллюстрации больше А4, то ее следует помещать в приложении. Фотоснимки размером меньше формата А4 должны быть наклеены на стандартные листы белой бумаги. Иллюстрации следует размещать так, чтобы их можно было рассматривать без поворота документа или с поворотом по часовой стрелке.

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

7.6.5 Иллюстрации, при необходимости, могут иметь наименование, например: «Рисунок В.2 - Схема алгоритма» и пояснительные данные (подрисуночный текст). Слово «рисунок», его номер и наименование помещают ниже изображения после пояснительных данных симметрично иллюстрации.

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

 

Рисунок 5 – График зависимости

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

Рисунок 6

Формулы

7.7.1 Формулы следует выделять из текста в отдельную строку. Выше и ниже каждой формулы или уравнения должно быть оставлено не менее одной свободной строки.

7.7.2 Формулы должны приводиться в общем виде с расшифровкой входящих в них буквенных значений. Буквы греческого, латинского алфавитов и цифры следует выполнять с помощью компьютерного набора курсивом или чертежным шрифтом в соответствии с требованиями стандартов ЕСКД. Высота букв и цифр должна быть в пределах 5-7 мм.

7.7.3 Если уравнение или формула не умещается в одну строку, то оно должно быть перенесено после знака равенства (=) или после знаков плюс (+), минус (-), умножения (´), деления (:), или других математических знаков, причем этот знак повторяют в начале следующей строки. При переносе формулы на знаке, символизирующем операцию умножения, применяют знак «´».

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

Пример-

Плотность в килограммах на кубический метр вычисляют по формуле

 

r = m / V, (7.1)

где r - плотность материала образца, кг/м³;

m - масса образца, кг;

V - объем образца, м³.

Размерность одного параметра в пределах всего ПЗ должна быть постоянной.

7.7.5 Формулы, следующие одна за другой и не разделенные текстом, отделяют запятой.

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

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

Пример -

D = (a+bx), (1)

Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы в пределах раздела, разделенных точкой, например (2.10) - десятая формула второго раздела. Формулы, помещаемые в приложениях, обозначают отдельной нумерацией, арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например формула (В.1). Ссылки в тексте на порядковые номера формул дают в скобках.

Пример –

… в формуле (1).

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

Неправильно:

Ом

Правильно:

кОм

Ссылки

7.8.1 В ПЗ допускаются ссылки на элементы самой ПЗ, стандарты, технические условия и другие документы при условии, что они полностью и однозначно определяют соответствующие требования и не вызывают затруднений в пользовании документом.

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

7.8.2.1. При ссылках на структурные части текста ПЗ указывают номера разделов (со словом «раздел»), приложений (со словом «приложение»), подразделов, пунктов, подпунктов, перечислений, например: «....в соответствии с разделом 2», «... согласно 3.1», «.., по 3.1.1»; «...в соответствии с 4.2.2, перечисление 6»; «(приложение Л)»; «... как указано в приложении М».

7.8.2.2 Ссылки в тексте на номер формулы дают в скобках, например: «...согласно формуле (В.1)»; «...как следует из выражения (2.5)».

7.8.2.3 Ссылки в тексте на таблицы и иллюстрации оформляют по типу: «(таблица 4.3)»; «... в таблице 1.1, графа 4»; «(рисунок 2.11)»; «... в соответствии с рисунком 1.2»; «... как показано на рисунке В.7, поз. 12 и 13».

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

7.8.3 При ссылке в тексте на использованные источники информации следует приводить порядковые номера по списку использованных источников, заключенные в квадратные скобки, например: «... как указано в монографии [103]»; «... в работах [11, 12, 15-17]».

При необходимости в дополнение к номеру источника указывают номер его раздела, подраздела, страницы, иллюстрации, таблицы, например: [12, раздел 2];[18, подраздел 1.3, приложение А]; [19, С. 28, таблица 8.3].

7.8.4 При ссылках на стандарты и технические условия указывают только их обозначение, при этом допускается не указывать год их утверждения при условии полного описания стандарта в списке использованных источников в соответствии с ГОСТ 7.1.

Сокращения

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

7.9.2 При первом упоминании должно быть приведено полное название с указанием в скобках сокращенного названия или аббревиатуры, например: «фильтр низкой частоты (ФНЧ)»; «амплитудная модуляция (АМ)», а при последующих упоминаниях следует употреблять сокращенное название или аббревиатуру.

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

Пример - ЭВМ, НИИ, АСУ, с. (страница), т. е. (то есть) и др.

Оформление расчетов

7.10.1 Расчеты в ПЗ должны выполняться с использованием физических величин системы СИ.

7.10.2 Порядок изложения расчетов в ПЗ определяется характером рассчитываемых величин. Согласно ЕСКД расчеты в общем случае должны содержать:

- эскиз или схему рассчитываемого изделия;

- задачу расчета (с указанием, что требуется определить при расчете);

- данные для расчета;

- условия расчета;

- расчет;

- заключение.

7.10.3 Эскиз или схема должны обеспечивать четкое представление о рассчитываемом объекте.

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

7.10.5 Условия расчета должны пояснять особенности принятой расчетной модели и применяемые средства автоматизации инженерного труда.

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

Пример –

«Расчет теплового режима проводим по методике, изложенной в [2]».

7.10.6 Расчет, как правило, разделяют на пункты, подпункты или перечисления. Пункты (подпункты, перечисления) расчета должны иметь пояснения.

Пример –

«определяем...»; «по графику, приведенному на рисунке 3.4, находим...»; «согласно рекомендациям [4], принимаем...».

В изложении расчета, выполненного с применением ЭВМ, следует привести краткое описание методики расчета с необходимыми формулами и, как правило, структурную схему алгоритма или программы расчета. Распечатка расчета с ЭВМ помещается в приложении, а в тексте делается ссылка.

Пример –

«... Результаты расчета на ЭВМ приведены в приложении С».

7.10.7 Заключение должно содержать выводы о соответствии объекта расчета требованиям, изложенным в задаче расчета.

Пример –

«Заключение: заданные допуски на размеры составных частей позволяют обеспечить сборку изделия по методу полной взаимозаменяемости».

Нумерация страниц

7.11.1 Страницы ПЗ следует нумеровать арабскими цифрами, соблюдая сквозную нумерацию по всему тексту. Номер страницы без точки проставляют в центре нижней части листа.

7.11.2 Титульный лист включают в общую нумерацию страниц, но номер страницы на нем не проставляют.

7.11.3 Иллюстрации и таблицы, расположенные на отдельных листах, включают в общую нумерацию страниц отчета. Иллюстрации и таблицы на листе формата А3 учитывают как одну страницу.