Материала пояснительной записки
3.1 Структура пояснительной записки
Пояснительная записка к магистерской работе, дипломному и курсовому проекту (работе) должна условно разделяться на:
- вводную часть;
- основную часть;
- приложения (если необходимо).
Структура пояснительной записки представлена на рисунке 1.
3.2 Вводная часть
Вводная часть содержит следующие структурные элементы:
- титульный лист (стр. 1);
- задание и календарный план (стр. 2,3);
- реферат (стр. 4);
- содержание (стр. 5);
- перечень условных обозначений, символов, единиц, сокращений и терминов (если необходимо).
3.3 Основная часть
Основная часть дипломного проекта должна содержать:
- введение;
- суть пояснительной записки;
- заключение;
- перечень ссылок.
| Вводная часть | Обложка Титульный лист Задание Календарный план Реферат Содержание Перечень условных обозначений | |||||||||
| Основная часть | Введение | |||||||||
| Суть пояснительной записки | Раздел | Подраздел | Пункт | Подпункт | ||||||
| 2.1 | ||||||||||
| Иллюстрации | 2.2 | |||||||||
| Рисунок 2.1 | 2.3 | 2.3.1 | ||||||||
| Рисунок 2.2 | 2.3.2 | 2.3.2.1 | ||||||||
| Рисунок 2.3 | 2.3.2.2 | |||||||||
| Таблицы | ||||||||||
| Таблица 2.1 | ||||||||||
| Таблица 2.2 | ||||||||||
| Таблица 2.3 | ||||||||||
| Заключение | ||||||||||
| Перечень ссылок | ||||||||||
| Приложения | Приложение А | |||||||||
| Приложение Б | Б.1 | |||||||||
| Б.2 | Б.2.1 | |||||||||
| Иллюстрации | Б.2.2 | |||||||||
| Рисунок Б.1 | Б.2.3 | |||||||||
| Рисунок Б.2 | ||||||||||
| Таблицы | ||||||||||
| Таблица Б.1 | ||||||||||
| Таблица Б.1 | ||||||||||
| Б.3 | ||||||||||
Рисунок 1 - Структура пояснительной записки
ТРЕБОВАНИЯ К ВВОДНОЙ ЧАСТИ
4.1 Титульный лист
Бланк титульного листа на курсовой, дипломный проект и магистерскую работу приведен в приложении Б.
4.2 Задание на выполнение работы
Задание размещается сразу же после титульного листа и представляет собой документ, определяющий объем и порядок выполнения работы. На бланке задания размещается календарный план работы, который составляется руководителем со студентом. Бланки заданий различного вида работ приведены в приложении В.
Задание и календарный план выполнения квалификационной работы магистра и специалиста утверждается заведующим кафедрой.
4.3 Реферат
Реферат предназначен для ознакомления с работой. Он должен быть кратким, информативным и содержать сведения, позволяющие представить сущность работы.
Реферат должен содержать:
- сведения об объеме записки, количестве рисунков, таблиц, приложений, количестве источников по перечню ссылок (все сведения приводят вместе с данными приложений);
- текст реферата;
- ключевые слова.
Текст реферата должен отображать информацию, представленную в пояснительной записке. Необходимо в приведенной последовательности дать ответ на следующие вопросы:
| - объект разработки или исследования; - цель работы; - методы исследования и аппаратура; - результаты и их новизна; - основные технико-эксплутационные, конструктивные и технологические характеристики; - степень внедрения; - рекомендации по использованию результатов работы - экономическая эффективность; - выводы. |
Реферат необходимо выполнять объемом не более 500 слов.
Ключевые слова, существенные для раскрытия сути записки, помещают после текста реферата.
Перечень ключевых слов включает от 5 до 15 слов, напечатанных прописными буквами в именительном падеже в строку через запятые.
Реферат заключен в рамочку. Внизу листа реферата студентом заполняется штамп. Размеры штампа для реферата приведены в приложении Г.
Пример написания реферата приведен в приложении Д.
4.4 Содержание
Пример написания содержания приведен в приложении Е.
4.5 Перечень условных обозначений, символов, единиц, сокращений
и терминов
После листа «Содержание» в тексте может быть раздел «Перечень условных обозначений, символов, единиц, сокращений и терминов». В этом разделе в алфавитном порядке поясняют все используемые в пояснительной записке малораспространенные условные обозначения, символы, единицы, сокращения и термины. Если во всем тексте пояснительной записки применяется менее 5 малораспространенных условных элементов, то раздел «Перечень …» организовывать нет необходимости (на усмотрение автора).
В любом случае, в тексте при первом появлении этих элементов дают их полное название, а в круглых скобках - условное сокращение.
Общепринятые сокращения (м., кг., га. и т.д.) пояснять не надо. Перечень общепринятых сокращений установлен в ГОСТе 2.316-68.
ТРЕБОВАНИЯ К СТРУКТУРНЫМ ЭЛЕМЕНТАМ ОСНОВНОЙ ЧАСТИ
5.1 Введение
Во введении кратко излагают:
- оценку современного состояния проблемы, отмечая при этом практически решенные задачи, существующие пробелы знаний в данной предметной области, ведущие фирмы и ведущих ученых и специалистов в данной области;
- мировые тенденции решения поставленных задач;
- актуальность данной работы и основание для ее проведения;
- цель работы и область применения;
- взаимосвязь с другими работами.
5.2 Суть работы
Суть работы - это изложение сведений о предмете (объекте) разработки или исследования, которые необходимы и достаточны для раскрытия сущности темы работы.
При изложении сути работы особое внимание уделяют новизне, надежности, безопасности, экологии. Каждый раздел должен содержать законченную информацию.
Если необходимо привести полные доказательства или подробности исследования (разработки), их размещают в приложениях.
Ответственность за достоверность сведений, содержащихся в пояснительной записке, несет исполнитель - студент.
5.3 Заключение
Заключение представляет собой оценку основных результатов, полученных студентом-дипломником в итоге выполнения дипломного проекта в целом и должно содержать:
- оценку полученных результатов работы с учетом мировых тенденций решения поставленной задачи;
- предполагаемые области использования результатов работы.
5.4 Перечень ссылок.
Перечень источников, на которые ссылаются в пояснительной записке, должен быть приведен в конце текста записки, начиная с новой страницы (см. приложение Ж). В соответствующих местах записки должны быть даны номера ссылок, помещенные в квадратные скобки.
Библиографические описания в перечне ссылок приводят либо в порядке, в котором они впервые упоминались в тексте, либо по алфавиту (вначале на русском языке, затем на иностранном).
ТРЕБОВАНИЯ К ПРИЛОЖЕНИЯМ
В приложениях помещают материал, который:
- является необходимым дополнением работы, но включение его в основную часть записки отвлекает от изложения сути работы;
- не может быть последовательно размещен в основной части записки из-за большого объема или способа воспроизведения. Например, объемные промежуточные вычисления приводят в приложении, а в тексте дают только конечные результаты и анализ результатов;
Внимание! Последнее приложение обязательно содержит перечень демонстрационных чертежей.
ПРАВИЛА ОФОРМЛЕНИЯ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ
7.1 Общие требования
Пояснительную записку оформляют на листах формата А4. Допускается использование формата АЗ, когда это необходимо.
Пояснительную записку полностью выполняют компьютерным способом на одной стороне листа белой бумаги.
Компьютерные файлы следует форматировать следующим образом:
| - Текстовый редатор………………………….. - параметры страниы………………...………. - ориентация страниы………………………... - поля: верхнее, нижнее, левое…………….…. правое …………………………...….. - тип шрифа…………………………………… - размер шрифа……………………………….. - междустрочный интерал…………………… формулы: - тип шрифта для функций и переменных….. - тип шрифта для греческих символов…….... - стиль символов…...……………………..…... размеры в формулах: - обычный символ……..……………………… - крупный индекс……………..………………. - мелкий индекс……………………………….. - крупный симол……………………………… - мелкий симол……………………………….. | Word for Windows формат А4 (А3) книжная 25 мм 15 мм Times New Roman 14 пунктов 1.5 Times New Roman Symbol нежирный, прямой 16 пунктов 10 пунктов 9 пунктов 20 пунктов 12 пунктов |
Сокращения слов и словосочетаний в записке должны быть сделаны в соответствии с действующими стандартами по библиотечному и издательскому делу.
Фамилии, названия учреждений, организаций, фирм и другие собственные имена приводят на языке оригинала. Допускается переводить собственные имена на язык пояснительной записки с добавлением при первом упоминании оригинального названия.
Структурные элементы «РЕФЕРАТ», «ПЕРЕЧЕНЬ УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СИМВОЛОВ, ЕДИНИЦ, СОКРАЩЕНИЙ И ТЕРМИНОВ», «ВВЕДЕНИЕ», «ВЫВОДЫ», «ПЕРЕЧЕНЬ ССЫЛОК» не нумеруют, а их наименования служат заголовками структурных элементов.
Разделы и подразделы должны иметь заголовки. Пункты и подпункты могут не иметь заголовков.
Каждый раздел начинается с новой страницы. Подразделы, пункты и подпункты продолжаются на текущей странице.
Если после наименования раздела, подраздела, пункта и подпункта в нижней части страницы расположена только одна строка текста, то такой структурный элемент начинается с новой страницы.
Заголовки разделов следует располагать в середине строки и печатать прописными буквами без точки в конце, не подчеркивая. Текст заголовка разделов выделяется жирным шрифтом.
Заголовки подразделов, пунктов и подпунктов следует начинать с абзацного отступа и печатать строчными буквами, кроме первой прописной, не подчеркивая, без точки в конце.
Абзацный отступ должен быть одинаковым по всему тексту записки и равным 1.25 на верхней линейке.
Переносы слов в заголовке не допускаются.
Если заголовок состоит из двух и более предложений,их разделяют точкой.
Расстояния:
- между предыдущим текстом и заголовком, заголовком и последующим текстом должно быть две пустые строки.
- между заголовком раздела и заголовком подраздела должно быть две пустые строки.
- между заголовками подразделов и подпунктов, следующими один за другим и не разделенных текстом,пустых строк быть не должно.
В тексте документа не допускается применять обороты разговорной речи, техницизмы, профессионализмы, произвольные словообразования.
7.2 Нумерация страниц и частей пояснительной записки
Страницы пояснительной записки следует нумеровать арабскими цифрами, соблюдая сквозную нумерацию по всему тексту. Номер страницы проставляют в правом верхнем углу страницы без точки в конце.
«Титульный лист» и «Задание» включают в общую нумерацию страниц записки. Номера страниц на титульном листе не проставляют.
Иллюстрации и таблицы, расположенные на отдельных страницах, включают в общую нумерацию страниц записки.
Разделы отчета должны иметь порядковую нумерацию в пределах всей расчетно-пояснительной записки и обозначаться арабскими цифрами без точки, например 1, 2, 3, и т.д.
Подразделы должны иметь порядковую нумерацию в пределах каждого раздела. Номер подраздела состоит из номера раздела и порядкового номера подраздела,разделенных точкой. После номера подраздела точку не ставят, например 1.1, 1.2 и т.д.
7.3 Перечень условных обозначений, символов, единиц, сокращений
и терминов
Перечень условных обозначений, символов, единиц, сокращений и терминов должен располагаться столбцом. Слева в алфавитном порядке приводят условные обозначения, символы, единицы, сокращения и термины, справа - их детальную расшифровку.
7.4 Иллюстрации
Все чертежи должны быть выполнены компьютерным способом.
На все иллюстрации (чертежи, рисунки, графики, схемы, диаграммы, фотоснимки) обязательно должны быть даны ссылки в тексте. При ссылке следует писать слово «рис.» с указанием ее номера.
Иллюстрации следует располагать в пояснительной записке непосредственно после текста, в котором они упоминаются впервые или на следующей странице.
Под иллюстрацией при необходимости помещают поясняющие данные (подрисуночный текст). После поясняющих данных помещают название иллюстрации по следующему правилу: слово «Рисунок», номер иллюстрации, дефис, название иллюстрации с прописной буквы. Например, «Рисунок 3.1 - Схема размещения».
Номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации в пределах раздела, разделенных точкой. Рисунок каждого приложения обозначают отдельной нумерацией. Номер рисунка в приложении состоит из буквы приложения и порядкового номера рисунка в пределах данного приложения, разделенных точкой.
Если иллюстрация не умещается на одной странице, ее можно переносить на другие страницы, при этом название иллюстрации помещают на первой странице, поясняющие данные - на каждой странице. Под ними указывают: «Рисунок ______, лист ________».
Если иллюстрации, помещенные в записке, созданы не автором, необходимо, представляя их в записке, соблюдать требования действующего законодательства об авторских правах.
7.5 Построение таблиц
Таблица может иметь название, которое помещают над таблицей с абзацного отступа. Структура названия: слово «таблица», номер таблицы, дефис, название таблицы с прописной буквы. Например, «Таблица 4.2 – Характеристики участка работ».
При переносе части таблицы название помещают только над первой частью таблицы. Над другими частями пишут «Продолжение таблицы __» с указанием номера.
Таблицы следует нумеровать арабскими цифрами сквозной нумерацией в пределах раздела. Номер таблицы состоит из номера раздела и порядкового номера таблицы в пределах раздела, разделенных точкой. Таблицы каждого приложения обозначают отдельной нумерацией. Номер таблицы в приложении состоит из буквы приложения и порядкового номера таблицы в пределах данного приложения, разделенных точкой.
На все таблицы записки должны быть ссылки в тексте. При ссылке следует писать слово «табл.» с указанием ее номера.
Таблицу необходимо помещать сразу под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости в приложении к документу.
Макет оформления таблицы приведен на рис. 2.
Заголовки граф таблицы печатают с прописных букв, а подзаголовки - со строчных, если они составляют одно предложение с заголовком. Подзаголовки, имеющие самостоятельное значение, пишут с прописной буквы. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.
Таблица _________ - _____________________________________
номер название таблицы
| Головка | Заголовки граф | |||||
| Подзаголовки граф | ||||||
| Строки (горизонтальные ряды) | ||||||
| Боковик (графа для заголовков строк) |
Графы ( колонки)
Рисунок 2 – Макет оформления таблицы
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
Разделять заголовки и подзаголовки диагональными линиями не допускается.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Если в конце страницы таблица прерывается и ее продолжение будет на следующей странице, в первой части таблицы нижнюю горизонтальную линию, ограничивающую таблицу не проводят.
При размещении таблицы на нескольких страницах, в начале каждой страницы повторяют названия строк и столбцов или заменяют названия соответственно номерами строк и столбцов. При этом, в первой части таблицы строки и столбцы обязательно нумеруют арабскими цифрами. Если таблица расположена в пределах одной страницы, строки и столбцы не нумеруются.
Таблицы с небольшим количеством граф допускается делить на части и помещать одну часть рядом с другой на одной странице. При этом повторяют головку таблицы. Рекомендуется разделять части таблицы двойной линией или линией толщиной 2.5.
Допускается разворачивать таблицу вдоль длинной стороны листа записки.
7.6 Формулы и уравнения
Формулы и уравнения располагают непосредственно после текста, в котором они упоминаются, посередине страницы.
Выше и ниже каждой формулы или уравнения должна быть оставлена одна свободная строка.
Формулы, следующие одна за другой и не разделенные текстом, отделяют запятой.
Формулы и уравнения в записке следует нумеровать порядковой нумерацией в пределах раздела. Номер формулы или уравнения указывают на уровне формулы или уравнения в круглых скобках в крайнем правом положении на строке. Номер формулы или уравнения состоит из номера раздела и порядкового номера формулы или уравнения в пределах раздела, разделенных точкой.
Пояснение значений символов и числовых коэффициентов, входящих в формулу или уравнение, следует приводить непосредственно под формулой в той последовательности, в которой они даны в формуле или уравнении. Пояснения следует начинать с абзаца словом «где» без двоеточия. Пояснения каждого символа и числового коэффициента следует давать с новой строки.
Пример:
Горизонтальное проложение наклонной длины определяется по формуле:
Lo = L * cosβ, (2.13)
где L – наклонная длина;
β – угол наклона.
7.7 Перечисления
Перед перечислением ставят двоеточие.
Перед каждой позицией перечисления следует ставить строчную букву украинского алфавита со скобкой, или, не нумеруя, дефис (первый уровень детализации). Для дальнейшей детализации перечисления следует использовать арабские цифры со скобкой (второй уровень детализации).
Пример:
а) плановая геодезическая сеть состоит из:
1) астрономо-геодезической сети 1 класса;
2) геодезической сети 2 класса;
3) геодезической сети сгущения 3 класса.
б) высотная геодезическая сеть состоит из:
1) нивелирной сети I и II классов;
2) нивелирной сети IIІ и IV классов.
Перечисления первого уровня детализации пишут строчными буквами с абзацного отступа. Перечисления второго уровня - с абзацного отступа относительно первого уровня.
7.8 Ссылки
Ссылки в тексте на источники следует указывать порядковым номером по перечню ссылок, выделенным двумя квадратными скобками, например, «... в работах [1, 5, 7]».
При ссылках на разделы, подразделы, пункты, подпункты, иллюстрации, таблицы, формулы, уравнения, приложения указывают их номера.
При ссылках следует писать: «.. в разделе 4...», «... смотри 2.1...», «...по 3.3.4...», «в соответствии с 2.3.4 ...», « на рис. 1.3...», или «на рисунке 1.3 ...», «... в таблице 3.2 ...», «... (см табл. 3.2 ...)», « по формуле (3.2)...», «в уравнениях (1.23) - (1.25)...», «... в приложении Б... ».
7.9 Примечания
Примечания помещают если необходимо пояснить содержание текста, таблицы или иллюстрации.
Примечания располагают непосредственно после текста, таблицы, иллюстрации, к которым оно относится.
Одно примечание не нумеруют.
Слово «Примечание» печатают с прописной буквы с абзацного отступа, не подчеркивают. После слова «Примечание» ставят точку и с прописной буквы в той же строке дают текст примечания.
Пример.
Примечание. _______________________________________
___________________________________________________
Несколько примечаний нумеруют последовательно арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие и с новой строки с абзаца после номера примечания с прописной буквы дают текст примечания.
Пример.
Примечания:
1._______________________________________________________
_________________________________________________________
2._______________________________________________________
_________________________________________________________
7.10 Сноски
Пояснения к отдельным данным, приведенным в тексте или таблицах, допускается оформлять сносками.
Сноски обозначают надстрочными знаками в виде арабских цифр (порядковых номеров) со скобкой.
Нумерация сносок отдельная для каждой страницы.
Знаки сносок ставят непосредственно после того слова, числа, символа, предложения, к которому дается пояснение, и перед текстом пояснения.
Текст сноски помещают под таблицей или в конце страницы и отделяют от таблицы или текста линией длиной 30-40 мм, проведенной в левой части страницы.
Текст сноски начинают с абзацного отступа и печатают одинарным межстрочным интервалом.
7.11 Приложения
Материал, дополняющий текст расчетно-пояснительной записки допускается помещать в приложениях. Приложениями могут быть, например графический материал, таблицы большого формата, расчеты, описания оборудования, описания алгоритмов и программ задач, если это не является основной задачей проекта (работы).
В тексте пояснительной записки на все приложения должны быть даны ссылки.
Приложения оформляют как продолжение данного документы на последующих его страницах и располагают в порядке ссылок на них в тексте пояснительной записки.
Приложения обозначают заглавными буквами украинского (русского) языка, начиная с А, за исключением Ё, 3, І, Й, О, Ч, Ь, Ы, Ъ. Если в документе одно приложение, оно обозначается «ПРИЛОЖЕНИЕ А».
Повторное напоминание: последнее приложение обязательно содержит перечень демонстрационных чертежей.
Каждое приложение следует начинать с новой страницы. Наверху посередине страницы пишут прописными буквами жирным шрифтом слово «ПРИЛОЖЕНИЕ» и его обозначение (например «ПРИЛОЖЕНИЕ Б»). Ниже слова «ПРИЛОЖЕНИЕ» с новой строки симметрично относительно текста с прописной буквы пишут название приложения.
Приложения должны иметь общую с остальной частью сквозную нумерацию страниц.
Источники, цитируемые только в приложениях, должны рассматриваться независимо от основной части отчета, и должны быть перечислены в конце каждого приложения в перечне ссылок. Форма цитирования, правила составления перечня ссылок и сносок должны быть аналогичны принятым в основной части отчета.
В приложениях перед номером ссылки, рисунка, таблицы, формулы и т.п. должна стоять буква приложения (например: рис. В.4, табл. Д.5).