Обозначение документации в дипломном проекте

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

- конструкторские документы – по ЕСКД;

- технологические документы – по ЕСТД;

- строительные документы – по СПДС;

- программные документы – по ЕСПД;

- документы для автоматизированной системы управления в соответствии с государственным стандартом системы технологической документации АСУ.

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

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

Например, ДП 350306.03.00.00.ПЗ

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

Первая группа из шести цифр (350306) обозначает код бакалавриата по направлению «Агроинженерия» соответствии с Перечнем направлений по которым ведётся подготовка в вузах Минсельхоза России.

В следующей паре знаков (03) записывается номер раздела пояснительной записки, в данном примере третий раздел.

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

ДП 350306.03.05.00 СБ – обозначение чертежа пятого сборочного узла (СБ) третьего раздела проекта.

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

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

ПЗ – пояснительная записка;

СБ – сборочный чертеж;

ВО – вид общий;

ЭС – электрическая схема;

ГЧ – габаритный чертеж;

ПС – принципиальная схема;

ГП – генеральный план;

АР – архитектурное решение;

ТК – технологическая карта;

ТО – технологическое описание и др.

Шифры и марки документов приведены в ГОСТ 2.102, ГОСТ 2.601, ГОСТ Р.21.1501.

5.2 Требования к оформлению расчетно-пояснительной записки

Расположение текста

Расчетно-пояснительная записка дипломного проекта выполняется студентом на одной стороне писчей нелинованной бумаги потребительского формата А4 ГОСТ 9327 со сторонами 297 х 210 мм и сброшюрована в папку.

Пояснительная записка дипломного проекта может быть оформлена одним из следующих способов: рукописным – четким почерком, тушью или пастой черного (фиолетового) цвета, высота букв и цифр не менее 2,5 мм, расстояние между основаниями строк не менее 10 мм; с применением компьютера, размер шрифта – 14, интервал – полуторный.

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

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

Абзацы в тексте начинаются отступом, равным пяти знакам (12…13 мм) при выполнении текста рукописным способом (на компьютере – с абзацного отступа).

Раздел «инженерные расчеты и решения» пояснительной записки выполняется в рамках: поле слева – 20 мм, справа, сверху и снизу – 5 мм. Расстояние от рамки формы до границ текста в начале и в конце строк – не менее 3 мм. Расстояние от верхней или нижней строки текста до верхней или нижней рамки – не менее 10 мм. На первых листах этого раздела выполняется основная надпись (штамп) формы 2 по ГОСТ 2. 104 – для конструкторских и технологических документов. На последующих листах выполняются основные надписи формы 2а. Формы 2, 2а и примеры заполнения в пояснительной записке основных надписей приводятся в приложениях Д и Е.

Номера страниц пояснительной записки, выполненных без рамок, проставляют арабскими цифрами в соответствии с ГОСТ 7.32 в центре нижней части листа без точки. Нумерация страниц – сквозная, включая титульный лист, задание, иллюстрации, приложения (на этих страницах номера страниц не проставляются, но подразумеваются).

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

Рубрикация

Текст пояснительной записки должен быть разделён на разделы и подразделы, а при необходимости – пункты и подпункты. Разделы должны иметь порядковые номера в пределах всей пояснительной записки, обозначенные арабскими цифрами без точки и записанные с абзацного отступа. Подразделы должны иметь нумерацию в пределах каждого раздела, соответственно пункты и подпункты. Номер подраздела состоит из номеров раздела и подраздела (пункта, подпункта), разделенных между собой точками. «Введение», «Аннотация», «Содержание», «Список использованных источников» не нумеруются, например:

Введение

1 Анализ состояния ремонтной базы

1.1 Общие сведения о ...

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

1.1.2 раздела проекта.

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

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

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

а) _________________

1)__________

б) _________________

1)__________

2)__________

в) _________________

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

Требования к изложению текста

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

Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят. Если заголовок состоит из двух предложений, их разделяют точкой (ГОСТ 2.105-95).

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

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

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

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

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

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

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

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

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

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

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

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

- использовать в тексте математический знак минус ( - ) перед отрицательными значениями величин. Следует писать: «Температура в камере должна быть минус 10°С»;

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

- не применять индексы стандартов без цифр, т.е. не использовать форму записи «выполнять по ГОСТу ...», но «... выполнять в соответствии с требованиями стандарта». Если необходимо сослаться на конкретный документ, то приводят его номер, применяя формы записи: «Основные размеры подшипников должны соответствовать ГОСТ 3478...» [3] или «...для контроля размера 22_-0,3 использовать микрометр МК 0-25 по ГОСТ 6507-78...» [3]. В первой ссылке не сообщается год утверждения (переиздания) стандарта, так как приведенное требование имеет форму будущего времени и должно оставаться в силе при дальнейших переизданиях основополагающего документа. Во втором случае указывается, что должен использоваться только один вид инструмента, изготовленный (свершившийся факт) в соответствии с требованиями, регламентируемыми стандартом определенного года выпуска.

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

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

Единицы физических величин необходимо применять в соответствии с ГОСТ 8.417. Числовые значения величин с обозначением единиц физических величин и единиц счёта следует писать цифрами, а числа без физических единиц и единиц счёта от единицы до девяти словами, например: «Зазор не более 2 мм», «Катушку пропитать два раза».

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

Требования к написанию формул

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

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

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

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

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

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

5.2.5 Требования к оформлению примечаний

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

Если имеется одно примечание, то его не нумеруют. После слова, «Примечание» ставят тире, и текст примечания пишут с прописной буквы, например:

Примечание – если диаметр 1 м.

Если примечаний несколько, то после слова «Примечания» ставят двоеточие. Примечания нумеруют арабскими цифрами без проставления точки, например:

Примечания:

1 если диаметр 1,0 м;

2 если диаметр 1,5 м.

Примечание к таблице помещают после таблицы над линией, обозначающей окончание таблицы.

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

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

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

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

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

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

Если в качестве иллюстрационного материала применяют в тексте фотографии, то оформление их идентично оформлению рисунков.

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

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

Приложения оформляют как продолжение пояснительной записки и располагают в порядке ссылок на них в тексте в конце документа. Каждое приложение начинается с новой страницы с указанием наверху посередине страницы слова «Приложение». Выполняют приложения на листах формата А4, допускается оформление и на листах форматов АЗ, А2, А1. Приложение должно иметь заголовок, который записывается симметрично относительно текста с прописной буквы отдельной строкой.

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

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

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

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

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

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

Основное требование к таблице – удобство использования помещаемой в ней информации. Для этого необходимо:

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

- не включать в нее второстепенные данные, так как они «затеняют» основные материалы;

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

- не допускать дублирование информации;

- не помещать в таблице разнородные материалы.

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

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

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

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

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

Таблицы в приложениях нумеровать арабскими цифрами с добавлением обозначения приложения. Например, «Таблица А.2» (таблица 2 приложения А).

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

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

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

Таблица 2.1 – Сроки выполнения работ, дней

Головка Виды работ	Зона
степная	Подзаголовки граф лесостепная
		3
Боронование
Культивация
Посев: пшеницы; кукурузы; трав		Строки
Посадка картофеля
Рыхление междурядий: кукурузы; картофеля

	Боковик
		Графы

Продолжение таблицы 2.1

Уборка: пшеницы; кукурузы; трав

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

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

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

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

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

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

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

С целью сокращения размеров таблицы, помещаемые в ней материалы, рекомендуется расчленять на интервалы, например: свыше 1 до 10; от 10 до 20 и т.д. Промежуточные числа (10 и другие) относить к одному интервалу, используя фразу: «до 10 вкл.» (включительно) или «до 10 искл.» (исключительно). Для сокращения текста разрешается слова, выражения, помещаемые в головке (боковике) таблицы, заменять общепринятыми буквенными (условными) обозначениями (аббревиатурами), если они пояснены в тексте или приведены на иллюстрациях, например: диаметр – D; длина – L; высота – Н и т.д. Текст в заголовках граф (строк) можно располагать более плотно, чем основной (например, через один интервал). Допускается применять размер шрифта в таблице меньший, чем в тексте.

Оформление таблиц должно соответствовать ГОСТ 1.5 и ГОСТ 2.105.

Если сведений мало (простое перечисление), то их лучше приводить в форме перечня, например, характеристика длинномера пневматического:

Габарит, мм:

- длинномера 130x447х280

- секции с отсчетным устройством 21x95x432

- блока фильтра со стабилизатором 90x105x165

- приставки 37x73,5x191

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

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

Оформление списка литературы

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

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

Оформление списка литературы должно соответствовать ГОСТ 7.1 «Библиографическое описание документа. Общие требования и правила составления».

Примеры библиографического описания приведены в приложении И.

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