8 Требования к оформлению текстовых документов

8.1 Текстовые документы проектов (работ) выполняются на белой бумаге формата А4 по ГОСТ 2.301 или по решению кафедры на формах, установленных соответствующими стандартами ЕСКД, ЕСТД, СПДС и ЕСПД на одной стороне листа на русском или белорусском языках.

8.2 Текст пояснительной записки печатается шрифтом Times New Roman одного размера – 12 или 14 пт, через одинарный межстрочный интервал, с соблюдением размеров полей, мм: справа – 5–8;слева – 22–23; снизу – 15; сверху – 20 (количество знаков в строке 60–75). В формулах и уравнениях размер основных символов соответствует размеру основного текста. Размер шрифтов надписей на рисунках, диаграммах и в таблицах должен соответствовать размеру шрифта основного текста. При выполнении проекта (работы) на стандартных листах формы 5 и 5а ГОСТ 2.106 или на формах ЕСТД и СПДС текст располагается от рамки, мм: слева и справа – 2–3; сверху – 15; снизу – вплотную к основной надписи. Заполнение основных надписей в пояснительной записке осуществляется чертежным шрифтом либо шрифтом основного текста.

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

8.3 Построение документа

8.3.1 Текст пояснительной записки разделяют на разделы и подразделы, а при необходимости – на пункты и подпункты в соответствии с ГОСТ 2.105 или ГОСТ 7.32.

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

8.3.3 Заголовки разделов и подразделов выполняются шрифтом основного текста и выделяются полужирным шрифтом; интервал между заголовком раздела и текстом составляет 18 пт; перед заголовком подраздела и текстом – 18 пт; после заголовка подраздела и текстом – 12 пт.

8.3.4 Пункты и подпункты названий не имеют и записываются текстом с абзацного отступа. Пункты и подпункты не разделяются между собой дополнительными интервалами.

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

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

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

Номер подпункта состоит из номеров раздела, подраздела, пункта и подпункта, разделенных точками (например, 3.1.1.1).

8.4 Структурным составляющим «Титульный лист», «Задание на курсовой проект (работу)», «Реферат», «Содержание», «Введение», «Заключение», «Список использованных источников» номера не присваиваются.

8.5 Разделы «Реферат», «Содержание», «Введение», «Заключение», «Список использованных источников» необходимо начинать с нового листа без рамки. Первые листы разделов выполняются с нового листа в рамке с основной надписью формы 2 ГОСТ 2.104 (Приложение Ж). Последующие листы выполняются в соответствии с требованиями кафедры.

8.6 Заполнение основной надписи

8.6.1 Заполнение основных надписей производится в соответствии с Приложением Ж.

В графе 1 пишется название раздела. В графе 2 – буквенно-цифровое обозначение (индекс) в виде КП (КР) ХХ ХХ ХХ ХХ ПЗ, которое устанавливается кафедрой.

В графе 10 помещаются:

«Разраб.» – фамилия исполнителя;

«Пров.» – фамилия руководителя проекта (работы);

«Н. контр.» (нормоконтролер) – фамилия нормоконтролера.

В графе 11 помещаются фамилии лиц соответственно графе 10;

в графе 12 – подписи лиц, указанных в графе 11;

в графе 13 – даты подписания.

В графе 4 указывается литера, соответствующая стадии разработки проекта (работы) по ГОСТ 2.103, присваиваемая руководителем проекта (работы). Для учебных проектов (работ) проставляется литера «У».

В графе 7 ставится 1.

В графе 8 указывается количество страниц в пределах одного раздела.

В графе 9 в первой строке пишется БГТУ, во второй последовательно располагается код факультета, кафедры, специальности студента и его порядковый номер по списку группы и последние две цифры года защиты курсового проекта (работы) без указания «год» или «г.». Коды приведены в Приложении К.

Остальные графы формы 2 не заполняются.

8.6.2 Содержание, расположение и размеры граф основных надписей на текстовых документах, входящих в состав проектной документации для ЕСТД, должны соответствовать ГОСТ 3.1103, для ЕСПД – ГОСТ 19.104, для СПДС – ГОСТ 21.101.

8.7 Ссылки

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

8.7.2 Ссылки приводят как на сторонние источники информации, так и на собственный документ.

8.7.3 В ссылке указывается порядковый номер по списку использованных источников в квадратных скобках и далее, при необходимости, через пробел номер формулы, таблицы, рисунка или страница, на которой располагается приводимая информация. Например, расчет экономической эффективности проводится по [8] с. 28.

8.8 Формулы, уравнения и примечания

8.8.1 Все расчеты выполняются только в системе СИ, за исключением использования формул из первоисточников, в которых употреблены внесистемные единицы. Результаты расчетов по формулам с внесистемными единицами должны быть переведены в единицы системы СИ.

8.8.2 Все формулы и уравнения нумеруются арабскими цифрами, сквозной нумерацией или в пределах раздела. В случае нумерации в пределах раздела номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой. Номер указывают в круглых скобках с правой стороны листа на уровне формулы. Одну формулу обозначают – (1).

Формула отделяется от текста отступом в один межстрочный интервал.

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

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

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

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

Например: Ориентировочная поверхность теплообмена F_ор, м², определяется по [8] формула (19):

, (4.5)

где Q – тепловой поток, Вт;

K_ор– ориентировочное значение коэффициента теплопередачи в аппарате, Вт/(м² К);

Δt_ср – средняя разность температур, К.

Q = 1,5010⁵Вт – по заданию;K_ор= 250 Вт/(м² К) – по данным, приведенным в справочнике [6] таблица 2.8 для аппаратов трубчатого типа при использовании органических теплоносителей; Δt_ср = 40 К принято из второго раздела записки.

м².

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

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

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

8.9 Оформление иллюстраций

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

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

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

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

8.9.5 Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД, ЕСТД, СПДС, ЕСПД.

8.9.6 Надписи на иллюстрациях выполняются чертежным шрифтом или шрифтом основного текста.

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

Иллюстрации отделяются от текста отступом 18 пт.

8.9.8 Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например, Рисунок А.3 (третий рисунок приложения А).

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

1

2

3

1 – блок А; 2 – блок Б; 3 – блок В.

Рисунок 2.1 – Монтажная схема прибора

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

8.10.1 Таблицы выполняются в соответствии с требованиями ГОСТ 2.105 и применяются для лучшей наглядности и удобства сравнения показателей.

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

8.10.3 Все таблицы нумеруются арабскими цифрами сквозной нумерацией или в пределах раздела. При нумерации в пределах раздела номер таблицы состоит из номера раздела и порядкового номера таблицы в данном разделе, разделенных точкой. Например, Таблица 5.1 (первая таблица пятого раздела). Знак № не ставится.

Слово «Таблица» и ее порядковый номер указывается слева над таблицей без абзацного отступа.

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

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

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

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

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

8.10.8 Заполнение таблицы производится шрифтом основного текста или при необходимости допускается использовать размер шрифта не менее 10 пт.

Таблица отделяется от текста отступом 18 пт.

8.10.9 Графа № п/п в таблицу не включается. Размерности величин, приведенных в таблице, указывают в заголовке строк или после наименования через запятую. Например, установленная мощность, кВт.

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

Ниже приводится пример выполнения таблицы.

Таблица 3.1 – Значения КПД червячного зацепления при различных скоростях

Частота вращения ведущего вала n1, мин–1	Крутящий момент на ведомом валу T2, Н мм	Число делений индикатора		Крутящий момент на ведущем валу T1, Н мм	Значение КПД
		нагрузочного устройства, i2	электро-двигателя, i1		экспериментальное	теоретическое
300	480	20	6,5	29,6	0,65	0,72
	960	40	13	50,5	0,65
	1440	60	20	90	0,69
600	460	20	6	24	0,71	0,76
	960	40	11	49,5	0,71
	1440	60	16	81	0,71
900	460	20	7	31,5	0,73	0,79
	960	40	13	56,5	0,75
	1440	60	18	81	0,71

Примечание – Значения крутящих моментов определяются с учетом тарировочных коэффициентов.

8.11 Оформление диаграмм и графиков

8.11.1 Диаграммы выполняются в соответствии с требованиями Р 50‑77-88.

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

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

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

8.11.4 Значения переменных величин следует откладывать на осях координат в линейном или нелинейном масштабах изображения. Масштаб, который может быть разным для каждого направления координат, выражается шкалой значений откладываемой величины.

8.11.5 Числа у шкал следует размещать вне поля диаграммы и располагать горизонтально.

8.11.6 Точки диаграммы, полученные путем измерения или расчетов, допускается обозначать графически, например кружком, крестиком и т. п. Обозначения точек должны быть приведены в пояснительных данных под диаграммой.

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

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

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

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

Пример выполнения диаграмм приводится в Приложении И.

8.11.10 Диаграммы следует выполнять линиями по ГОСТ 2.303. Оси координат, оси шкал, ограничивающие поле диаграммы, следует выполнять основной линией. Линии координатной сетки и делительные штрихи следует выполнять сплошной тонкой линией.

8.11.11 Надписи на диаграммах и графиках выполняются чертежным шрифтом или шрифтом основного текста.

8.12 В тексте пояснительной записки не допускается:

– употреблять обороты разговорной речи, техницизмы, профессионализмы;

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

– применять произвольные словообразования и сокращения слов, кроме установленных правилами орфографии и соответствующими стандартами по ГОСТ 2.316, ГОСТ 7.12;

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

– употреблять математические знаки без цифр и вне формул, например ≤ (менее или равно), ≥ (более или равно), ≠ (не равно), а также знаки № (номер), % (процент);

– применять индексы стандартов (ГОСТ, СТБ, КТП, СТП, ТУ) без регистрационного номера;

– использовать в тексте математический знак (–) минус перед отрицательными значениями величин, следует писать слово «минус».

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

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

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

8.15 При разработке программной документации правила ее выполнения регламентируются стандартами ЕСПД.

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

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