Построение текста вкр (пояснительная записка ПЗ)

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

Разделы должны иметь порядковые номера в пределах всего отчета, обозначенные арабскими цифрами без точки (пример – 1, 2, 3 и т.д.) и записанные с абзацного отступа. Исключение составляют разделы: "Содержание", "Введение", "Заключение", "Список используемых источников", которые не нумеруются. Выделение жирным шрифтом не допускается.

Переносы в заголовках не допускаются.

Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. В конце номера подраздела точка не ставится (пример – 1.1, 1.2, 1.3 и т.д.). Разделы, как и подразделы, могут состоять из одного или нескольких пунктов (пример – 1.1.1, 1.1.2, 1.1.3 и т.д.).

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

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

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

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

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

Изложение текста документа

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

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

В тексте документа не допускается:

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

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

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

В тексте ПЗ, за исключением формул, таблиц и рисунков, не допускается:

n применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово "минус")

n применять знак "Æ" для обозначения диаметра (следует писать слово "диаметр").

n применять без числовых значений математические знаки.

Перечень допускаемых сокращений слов установлен в ГОСТ 2.316-68.

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

В документе следует применять стандартизованные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417- 81.

Наряду с единицами СИ, при необходимости, в скобках указывают единицы ранее применявшихся систем, разрешенных к применению. Применение в одном документе разных систем обозначения физических величин не допускается.

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

Примеры:

1. Провести испытания пяти труб, каждая длиной 5 м.

2. Отобрать 15 труб для испытаний на давление.

Единица физической величины (ФВ) одного и того же параметра в пределах одного документа должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице ФВ, то ее указывают после последнего числового значения, например 1,75; 2,00 м

Если в тексте приводят диапазон числовых значений ФВ, то обозначение единицы ФВ указывается после последнего числового значения диапазона. Примеры. От 1 до 5 мм. От 10 до 100 кг. Недопустимо отделять единицу ФВ от числового значения (переносить их на разные строки или страницы), кроме единиц ФВ, помещаемых в таблицах, выполненных машинописным способом.

Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать, например: 1/4^².

При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, например, 5/32; (50А - 4С)/(40В + 20).

Перечисления

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

 

 

Пример

-___________________________________________________________

  а)_______________________________________________________

       1)______________________________________________________

       2)_____________________________________________________

б)    

       1)______________________________________________________

       2)_____________________________________________________

-___________________________________________________________

  а)_______________________________________________________

       1)______________________________________________________

       2)_____________________________________________________

б)    

       1)______________________________________________________

       2)_____________________________________________________

Формулы

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

Пример - Диаметр проволоки пружины d, м, определяется по формуле

 

 

                                                                                   (2.1)

 

 

где F- сила, Н;

к – поправочный коэффициент;

с – индекс пружины;

[t] – допустимое напряжение, Па.

 

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

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

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

Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например (3.1).

При переносе формулы номер указывается в строке с ее окончанием. Для систем уравнений номер записывается на уровне середины знака системы.

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

Примечания

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

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

 

Примечание - _____________________________

Примечания

1 ______________________

2 ______________________

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

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

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

Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например - Рисунок 1.1.

При ссылках на иллюстрации следует писать "... в соответствии с рисунком 2" при сквозной нумерации и "...в соответствии с рисунком 1.2" при нумерации в пределах раздела.

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

Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово "Рисунок" и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 - Детали прибора. Пример оформления рисунка приведен на рисунке 3.1.

 

 

Рисунок 2.1 – Схема наплавки в среде углекислого газа (1- наплавочная головка; 2 – зона подачи СО₂; 3 – наплавленный металл; 4 – деталь)

 

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

Указанные данные наносят на иллюстрациях согласно ГОСТ 2.109-73.

Оформление приложений

Материал, дополняющий текст ПЗ, помещается в приложениях.

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

В тексте ПЗ на все приложения должны быть ссылки. Приложения располагают в порядке ссылок на них в тексте ПЗ.

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

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

Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Е, З, Й,О,Ч,Ь,Ъ,Ы. После слова "Приложение" следует буква, обозначающая его последовательность.

Допускается обозначение приложений буквами латинского алфавита, за исключением букв I,O.

Если в документе одно приложение, оно обозначается "Приложение А".

Приложения, как правило, выполняют на листах формата А4.

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

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

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

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

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

Цифровой материал, как правило, оформляют в виде таблиц в соответствии с рисунком 3.2.

 

Рисунок 2.2

 

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

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

На все таблицы должны быть приведены ссылки в тексте ПЗ, при ссылке следует писать слово "таблица" с указанием ее номера.

Таблицы располагаются либо на отдельных листах формата А4, либо в разрывах текстовой части.

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

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

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

Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.

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

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

Головка таблицы должна быть отделена линией от остальной части таблицы.

Высота строк таблицы должна быть не менее 8 мм.

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

Допускается помещать таблицу вдоль длинной стороны листа документа.

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

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

Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице, при этом повторяют головку таблицы в соответствии с рисунком 3.4. Рекомендуется разделять части таблицы двойной линией или линией толщиной 2S.

 

Таблица - В миллиметрах

Номинальный диаметр резьбы болта	Внутренний диаметр шайбы	Толщина шайбы
		легкой		нормальной
		a	b	a	b
1	2	3	4	5	6
2,0	2.1	0,5	0,8	0,5	0,5
2,5	2,6	0,8	1,0	0,8	0,6
3,0	3,1	0,8	1,0	0,8	0,8
4,0	4,1	1,0	1,2	1,0	1,2

Рисунок 2.3

 

Таблица - …

Диаметр стержня, мм	Масса 1000 шт. шайб, кг		Диаметр стержня, мм	Масса 1000 шт. шайб, кг
1,1 1,2 1,4	0,045 0,043 0,111		2,0 2,5 3,0	0,192 0,350 0,553

Рисунок 2.4

 

Графу "Номер по порядку" в таблицу включать не допускается. При необходимости нумерации показателей, параметров и других данных порядковые номера следует указывать в первой графе (боковике) таблицы непосредственно перед их наименованием в соответствии с рисунком 3.5.

 

Таблица -…

Наименование показателя	Значение
	в режиме 1	в режиме 2
1 Ток коллектора, А 2 Напряжение на коллекторе, В 3 Сопротивление нагрузки коллектора, Ом	5, не менее - 30	7, не более - 20

 

Рисунок 2.5

 

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

Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными ГОСТ 2.321-84, или другими обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например D - диаметр, H - высота.

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

 

   Таблица - …

Диаметр зенкера	С	S
От 10 до 11 включ. Св.11 " 12 " " 12 " 14 "	3,17 4,85 5,50	1,00 1,60 2,00

Рисунок 2.6

 

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

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

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

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

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

При отсутствии отдельных данных в таблице следует ставить прочерк (тире) в соответствии с рисунком 3.5.

Числовое значение показателя проставляют на уровне последней строки наименования показателя в соответствии с рисунком 3.5.

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

При указании в таблицах последовательных интервалов чисел, охватывающих все числа ряда, их следует записывать: "От... до... включ.", "Св... до... включ." в соответствии с рисунком 3.6.

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

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

Сноски

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

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

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

Знак сноски выполняют арабскими цифрами со скобкой и помещают на уровне верхнего обреза шрифта.

Нумерация сносок отдельная для каждой страницы.

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

Графики и диаграммы

Их выполняют согласно рекомендациям Р 50-77-88 "ЕСКД. Правила выполнения диаграмм".

Диаграммы и графики могут быть представлены:

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

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

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

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

- координатной сеткой;

- делительными штрихами;

- сочетанием координатной сетки и делительных штрихов.

Шкалы, расположенные параллельно координатной оси, следует разделять только делительными штрихами.

Числовые значения отметок подписываются вне поля диаграммы и располагаются горизонтально. Если началом числовых шкал является одно и то же число, оно указывается один раз на пересечении шкал.

На качественных диаграммах координатные оси на интервалы не делятся и не имеют никаких числовых значений.

В качестве числовых шкал допускается использовать:

- непосредственно координатные оси;

- линии координатной сетки, ограничивающие поле диаграммы;

- выносные линии, расположенные параллельно осям.

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

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

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

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

При нанесении нескольких зависимостей допускается пользоваться линиями различных типов согласно ГОСТ 2.303-68.

При слиянии линий вычерчивается одна из них.

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

Обозначение физических величин (переменных) производится с внешней стороны диаграммы в середине или в конце координатной оси одним из следующих способов:

- условным символом;

- наименованием;

- наименованием и символом;

- математическим выражением функциональной зависимости.

Символьные значения, включая математические выражения, записывают только горизонтально.

Наименования шкал в виде словесных терминов записываются параллельно соответствующей оси.

Единицы измерения величин указываются одним из следующих способов:

- в конце шкалы между последним и предпоследним числами (при недостатке места допускается предпоследнее число опускать);

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

- в конце шкалы вместе с обозначением переменной величины в виде дроби, в числителе которой – обозначение величины, а в знаменателе – название единицы измерения.

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

Пересечение надписей с линиями графиков или линиями координатной сетки не допускается.

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

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

Пример оформления графиков и диаграмм приведен в приложении В.