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

ДИПЛОМНОЕ ПРОЕКТИРОВАНИЕ

методические указания

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

для бакалавров направления «Нефтегазовое дело»

очной и заочной форм обучения

(часть 3)

Тюмень

ТюмГНГУ

Утверждено редакционно-издательским советом

федерального государственного бюджетного образовательного учреждения

высшего профессионального образования

«Тюменский государственный нефтегазовый университет»

Составители: Овчинников В.П. - доктор технических наук, профессор

Аксёнова Н.А. – кандидат технических наук, доцент

Мартынова Ю.Б. – ст. преподаватель

Семененко Т.М. - нормоконтролер

Ó Тюменский государственный нефтегазовый университет, 2011

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

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

Дипломная работа и курсовая работа (проект) состоят из пояснительной записки (ПЗ) и графической части (демонстрационного материала).

Оформление пояснительной записки

1.1 ПЗ выполняется на листах белой бумаги формата А4 (210´297 мм) с одной стороны с применением печатающих и графических устройств вывода ПЭВМ, шрифт обычный, № 14, интервал междустрочный - одинарный.

1.2 Расстояние от рамки формы до границ текста следует оставлять в начале и конце строк – не менее 3 мм.

Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм.

Абзацы в тексте начинают отступом, равным 15-17 мм.

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

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

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

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

1.5 Первый (титульный лист) ПЗ оформляется в соответствии с рисунками А.1 – А.3.

1.6 Курсовая работа (проект) и дипломная работа должны иметь основную надпись (приложение Б). Контрольные (лабораторные, рефераты) и отчеты по практикам основной надписи не имеют.

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

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

2.1.1 Содержание ПЗ разделяют на разделы, подразделы, пункты и подпункты.

2.1.2 Разделы должны иметь порядковые номера, обозначенные арабскими цифрами (1; 2; 3 и т.д.) без точки.

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

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

2.1.3 Если раздел не имеет подраздела, то нумерация пунктов должна быть в пределах раздела. Номер пункта должен состоять из номера раздела и пункта, разделенных точкой (7.1; 7.2; 7.3 и т.д.). В конце пункта точка не ставится.

2.1.4 Если раздел или подраздел состоит из одного пункта, он также нумеруется.

2.1.5 Пункты при необходимости, могут быть разбиты на подпункты (1.2.1.1; 1.2.1.2; 1.2.1.3 и т.д.).

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

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

Например:

а)

б)

1)

2)

в)

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

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

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

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

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

Расстояние между заголовком и текстом при выполнении записки машинописным способом должно быть равно 3,4 интервалам, при выполнении рукописным – 15 мм. Расстояние между заголовками раздела и подраздела – 2 интервала, при выполнении рукописным способом – 8 мм.

2.2 Изложение текста записки

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

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

Допускается использовать повествовательную форму изложения, например «применяют», «указывают» и т.д.

Приводя наибольшие или наименьшие значения величин, следует применять словосочетание «должно быть не более (не менее)».

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

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

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

2.2.2 В тексте записки не допускается:

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

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

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

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

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

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

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

- применять знак «Æ» для обозначения диаметра (следует писать слово «диаметр»). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте записки, перед размерным числом следует писать Æ 325; Æ 20±0,21;

- применять без числовых значений математические знаки, например
> (больше), < (меньше), = (равно), ³ (больше или равно), £ (меньше или равно), ¹ (не равно), а также знаки № (номер), % (процент);

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

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

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

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

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

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

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

Примеры

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

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

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

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

Примеры

1 От 1 до 5 мм.

2 От 10 до 100 кг.

3 От + 10 до минус 40 ⁰С

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

2.2.10 Интервалы чисел в тексте записывают со словами «от» и «до» (имея в виду «От и до … включительно»), если после чисел указана единица физической величины или числа представляют безразмерные коэффициенты, или через дефис, если числа представляют порядковые номера.

Примеры

1 Толщина льда на реках и озерах от 0,2 до 0,5 м.

2 7-12, рисунок 1-14.

2.2.11 Приводя в записке наибольшие, наименьшие значения величин или допустимые значения отклонений от указанных норм, требований следует применять словосочетание «должно быть не более (не менее)», «не должно быть более (менее)».

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

Дробные числа необходимо приводить в виде десятичных дробей за исключением размеров в дюймах, которые следует записывать ¼^²; ½^²
(но не ; ).

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

Пример – 5/32; (50А-4С)/(40В+20)

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

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

Таблица _______ - ___________________

номер название таблицы

Головка					Заголовки граф
			Подзаголовки граф
						Строки
						(горизонтальные ряды)

Боковик (графа Графы (колонки)

для заголовок)

Рис. 1

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

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

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

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

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

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

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

Показатели с одним и тем же буквенным обозначением группируют последовательно в порядке возрастания индексов (L; L₁; L₂; L₃ и т.д.).

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

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

2.3.6 Если строки или графы выходят за формат страницы в длину или ширину, то таблицу делят на части:

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

- при продолжении таблицы в длину указываются головка и номера граф. Над таблицей – «Окончание таблицы 1».

2.3.7 Графу «Номер по порядку» в таблицу включать не допускается.

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

2.3.8 Ограничительные слова «более», «не более», «менее», «не менее» и др. должны быть помещены в одной строке или графе таблицы с наименованием соответствующего показателя после обозначения его физической величины, если они относятся ко всей графе (масса, кг, не более) или в каждой строке соответствующей графы (5, не менее; 7, не более). После наименования показателя перед ограничительными словами ставится запятая.

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

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

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

a		a
305¢3¢¢		305¢30¢¢
4023¢5¢¢		4023¢50¢¢
5030¢2¢¢		5030¢20¢¢

Рис. 2

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

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

Если повторяется лишь часть фразы, то эта часть заменяется словами “То же” с добавлением дополнительных сведений.

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

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

2.3.14 Интервалы чисел записывают через дефис, если числа представляют порядковые номера, в тексте таблицы словами “от” и “до” (имея в виду “от и до… включительно), если после числа указана единица физической величины или числа являются безразмерными коэффициентами.

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

Знак сноски ставят непосредственно после того слова, числа, символа к которому дается пояснение. Знак сноски – арабская цифра со скобкой и помещают его на уровне верхнего обреза шрифта (21¹⁾). Нумерация сносок отдельная для каждой таблицы. Значение сноски располагают в конце таблицы с абзацного отступа, отделяя основные данные короткой тонкой горизонтальной линией. После разъяснений сносок проводится горизонтальная линия таблицы.

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

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

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

2.4 Формулы

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

Ссылки в тексте на порядковые номера формул дают в скобках, например, … в формуле (1).

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

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

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

Пример

Определяем массу Q в килограммах одноразмерной бурильной колонны из труб диаметром 127 мм и толщиной стенки 9 мм

Q = q × L, (1)

где q – масса одного метра бурильной трубы, кг/м; q = 30 кг/м [2,

таблица 13];

L – длина колонны, м; L = 2000 м (по заданию на курсовое

проектирование).

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

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

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

2.4.4 Формулы и математические уравнения следует выделять из текста свободными строками, необходимо выдерживать следующие размеры знаков: прописные буквы и цифры – 7-8 мм; строчные – 4 мм; показатели степени и индексы – не менее 2 мм.

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

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

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

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

2.5.2 Иллюстрация обозначается словом “Рисунок”, который следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается “Рисунок 1” или “Рисунок А.1” (при ссылки на рисунок в приложении).

2.5.3 Иллюстрации должны иметь наименование и пояснительные данные (подрисуночный текст). Слово “Рисунок” и наименование помещают после пояснительных данных.

Пример

1 –цементный камень; 2 – обсадная колонна; 3 – буровой раствор; 4 – стенка скважины.

Рисунок 1 – Схема к расчету обсадной колонны

На все иллюстрации должны быть даны ссылки в записке (“Рисунок 1”; на “Рисунке 2”).

2.5.4 Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД, СПДС и Р 50-77-78.

2.6 Сноски

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

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

Пример – «Интервал от 1610 до 2200¹⁾ м

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

Разъяснение сноски располагают с абзацного отступа в конце страницы (для рефератов и отчетов по практике) и над основной надписью записки в курсовом и дипломном проекте (работе). Отделяют сноску от текста тонкой горизонтальной линией с левой стороны. Обозначение (знак) – перед текстом пояснения.

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

2.7 Ссылки

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

2.7.2 При ссылках следует писать: “…в соответствии с разделом 2”, “… согласно 3.1”, “… по 3.1”, “… в соответствии с 4.2.2, перечисление б”, … в соответствии с таблицей 1”, “(таблица 4)”, “… в соответствии с рисунком А.5”, (рисунок 5), “…по формуле (3)”, (приложение Г) и т.д.

При ссылках на структурную часть текста, имеющую нумерацию из цифр, не разделенных точкой, следует указывать наименование этой части полностью, цифру – после наименования, например, “… в соответствии с разделом 5”, по пункту 3”, а при нумерации из цифр, разделенных точкой, наименование структурной части не указывают (по 4.10; в соответствии с 2.12).

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

Пример– ГОСТ 2.105.

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

Пример – ПЦТ II-СС-50 ГОСТ 1581.

2.7.5 При ссылке на условное обозначение (комплектующее изделие, оборудование и т.п.), следует указывать их полное наименование, тип или марку.

2.7.6 Допускается ссылаться на инструкции, правила, литературу, отчеты предприятий (организаций) и т.д.

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

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

При оформлении «списка» следует руководствоваться ГОСТ 7.1 и приложением Г.

2.8 Приложения

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

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

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

Допускается обозначение приложений буквами латинского алфавита за исключением букв 1 и 0. Если в ПЗ одно приложение, оно обозначается «Приложение А».

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

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

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

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

2.8.6 Приложения выполняют на листах формата А4, допускается оформлять на листах формата А3, А4´3; А4´4; А2 и А1 по ГОСТ 2.301.

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

2.9 Содержание

2.9.1 Слово «Содержание» в виде заголовка записывают симметрично тексту с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной.

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

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