2. Общие требования к оформлению учебной технической документации

К учебным техническим документам относятся:

– выпускные квалификационные работы (выпускная работа бакалавра, дипломный проект и работа, магистерская диссертация)

– курсовые проекты и работы;

– отчеты по производственной практике;

– отчеты по лабораторным работам;

– отчеты по научно-исследовательской работе студентов (НИРС).

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

Пояснительная записка должна содержать расчетную и описательную части. Текст записки располагают на одной стороне листа формата А4: 297210 миллиметров [3].

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

Графическая часть выполняется на листах формата А1 (594 х 841 мм) с соблюдением установленных стандартов.

3. Оформление пояснительных записок

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

Требования к построению и выполнению текстовых документов изложены в [4].

Для дипломных проектов в соответствии с «Положением о выпускной квалификационной работе ОмГТУ» рекомендуется следующая структура пояснительной записки:

• титульный лист;

• задание и исходные данные на проектирование;

• реферат;

• содержание;

• определения, обозначения и сокращения

• введение;

• основные разделы проекта;

• дополнительные разделы проекта;

• экономическая часть;

• раздел безопасности жизнедеятельности

• заключение;

• библиографический список;

• приложения.

Реферат – это краткое изложение работы. Должен содержать:

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

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

– текст реферата. Текст реферата должен быть предельно лаконичным и информативным, объемом не менее 1000 знаков. Текст реферата должен содержать:

– задачи и цели выпускной работы;

– актуальность, новизну и эффективность;

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

Для бакалаврских работ вместо реферата прилагается аннотация, в которой отражаются основные положения работы. Объем аннотации – не более 1000 знаков.

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

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

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

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

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

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

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

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

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

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

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

Библиографический список должен быть оформлен в соответствии с [5] и содержать сведения о литературных источниках и информационных ресурсах Internet, использованных при выполнении квалификационной работы, в порядке их упоминания в пояснительной записке. На источники обязательно по тексту должны быть ссылки.

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

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

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

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

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

Структура и порядок выполнения академических тем дипломных проектов детально рассмотрены в [6].

Допускается оформлять приложения на листах формата А3, А4 по [3]. Приложение форматом больше А4 учитывается как одна страница.

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

Пояснительная записка выполняется на белой бумаге форматом А4 аккуратно, технически грамотно, без исправлений в соответствии с требованиями [4, 7]. Текст пояснительной записки может быть выполнен одним из следующих способов: рукописным – основным чертежным шрифтом [8]; машинописным (через два интервала); с применением печатающих устройств персонального компьютера (14 шрифт; межстрочный интервал – множитель 1,2 процессора «Microsoft Word» или ему подобного).

По сторонам листа формата А4 должны быть оставлены поля. Размер левого поля – 30 мм, правого – 10 мм, верхнего и нижнего полей – 20 мм. Рамка выполняется в соответствии с [4] формы 2 и 2а [9]. Расстояние от рамки формы до границ текста в начале и в конце строк – не менее 3 мм. Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм [4].

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

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

Расстояние между заголовком и последующим текстом не менее 10мм. Расстояние между текстом и последующим заголовком не менее 15мм. Абзацы в тексте выполняются отступом, равным 15мм [4].

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

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

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

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

При ссылках на стандарты указывается только их обозначение, а полное название и год утверждения оформляется в списке литературы. Например: «… оформляется согласно ГОСТ 2.105 [4] ».

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

При ссылках на иллюстрации следует писать: «…в соответствии с рисунком 5».

При ссылках на материал, приведённый в приложении данной записки, следует писать: «… по формуле (А.1)…», при ссылке на формулу и «… (смотри рисунок В.2)», при ссылке на иллюстрацию.

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

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

• Применять обороты разговорной речи;

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

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

• Применять сокращения слов, кроме, установленных правилами русской орфографии [10];

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

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

Уравнения и формулы следует выделять в отдельную строку, выше и ниже которой должно быть оставлено не менее одного интервала.

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

Формулы рекомендуется изображать с помощью редактора формул текстового процессора Microsoft Word или ему подобного.

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

Размеры основных шрифтов формул, а также индексов и символов:

– обычный (Times New Roman) :	14 кегль;
– крупный индекс:	10 кегль;
– мелкий индекс:	8 кегль;
– крупный символ:	14 кегль.
– мелкий символ:	10 кегль;

Расчетные формулы приводятся в общем виде с последующей подстановкой числовых значений, окончательным результатом вычислений и обязательно с указанием размерностей. Переносы формул на другую строку допускаются на знаках равенства (=), умножения (×), сложения (+), вычитания (−), соотношений больше–меньше (>,<), деления (:).

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

Пример:

Эффективное число электроприемников подгруппы определяется по формуле:

(1)

где р_н – номинальная мощность одного электроприемника;

n – число электроприемников в подгруппе.

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

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

При оформлении расчётной части проекта в пояснительной записке рекомендуется использовать следующую последовательность:

• расчётная формула;

• числовая подстановка значений;

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

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

Пояснительная записка должна быть сброшюрована или переплетена.