Правила оформления текстовых документов
МЕТОДИЧЕСКИЕ РЕКОМЕНДАЦИИ
По нормоконтролю проектной документации
для преподавателей и студентов всех форм обучения
Волхов
| Учебное пособие рассмотрено и одобрено цикловой комиссией 08.02.09 Председатель ______ И.А. Борошнев Протокол №____ от _________2016г. Учебное пособие рассмотрено и одобрено цикловой комиссией 15.02.01 Председатель ______ С.В. Гаврилов Протокол №____ от _________2016г. Учебное пособие рассмотрено и одобрено цикловой комиссией специальностей 18.02.03 и 22.02.02 Председатель _____ Н.В. Борошнева Протокол №____ от _________2016г. Учебное пособие рассмотрено и одобрено цикловой комиссией 23.02.03 Председатель ______ А.В. Алешкин Протокол №____ от _________2016г. Учебное пособие рассмотрено и одобрено цикловой комиссией специальностей 38.02.01 и 40.02.02 Председатель ______ С.В. Фролова Протокол №____ от _________2016г. |
УТВЕРЖДАЮ
Зам.директора по учебной работе
___________ Токаренко В.Ю.
«____» ___________ 2016г.
Организация – разработчик:
Государственное бюджетное профессиональное образовательное учреждение Ленинградской области «Волховский алюминиевый колледж»
Разработчики:
Алёшкин А.В. – преподаватель ГБПОУ ЛО «Волховский алюминиевый колледж», председатель цикловой комиссии 23.02.03 «Техническое обслуживание и ремонт автомобильного транспорта»;
Рябинина Т.М. – методист ГБПОУ ЛО «Волховский алюминиевый колледж»;
Шевчук Н.В., преподаватель высшей категории ГБПОУ ЛО «Волховский алюминиевый колледж»
Содержание
Введение. 6
1 Общие положения. 8
2 Правила оформления текстовых документов. 10
2.1 Общие требования. 10
2.2 Построение документа. 10
2.3 Изложение текста. 12
2.4 Оформление иллюстраций. 14
2.5 Построение таблиц. 15
3 Оформление основной надписи. 18
4 Структура и содержание пояснительной записки. 20
4.1 Структура дипломного проекта. 20
4.1.1 Титульный лист. 21
4.1.2 Содержание. 21
4.1.3 Введение. 21
4.1.4 Основная часть. 22
4.1.5 Расчетно-технологическая часть. 22
4.1.6 Экономическая часть. 22
4.1.7 Техника безопасности (охрана труда) 22
4.1.8 Заключение. 23
4.1.9 Список литературы.. 23
4.1.10 Приложения. 23
4.2 Структура дипломной работы.. 23
4.2.1 Титульный лист. 24
4.2.2 Содержание. 24
4.2.3 Введение. 24
4.2.4 Основная часть. 25
4.2.5 Заключение. 25
4.2.6 Список литературы.. 25
4.2.7 Приложения. 25
4.3 Структура курсового проекта. 26
4.4 Структура курсовой работы.. 27
4.5 Структура отчета по практике. 29
4.6 Структура реферата, доклада, сообщения. 31
5 Оформление списка литературы.. 33
6 Оформление приложений. 35
7 Графическая часть проекта. 36
9 Подготовка к защите дипломных проектов (работ) 39
Литература. 41
Приложение А. Образец написания текста пояснительной записки
Приложение Б. Образец выполнения рамки
Приложение В. Образец выполнения рисунков
Приложение Г. Образец выполнения таблиц
Приложение Д. Образец титульного листа к дипломному проекту
Приложение Е. Образец листа «Содержание» к дипломному проекту
Приложение Ж. Образец выполнения листа «Литература»
Приложение И. Образец листа «Список использованных источников»
Приложение К. Образец титульного листа к курсовому проекту
Приложение Л. Образец листа «Содержание» к курсовому проекту
Приложение М. Образец титульного листа к отчету по практике
Приложение Н. Образец титульного листа к реферату
Приложение П. Образец титульного листа к докладу
Приложение Р. Образец титульного листа к сообщению
Приложение С. Образец выполнения листа «Содержание» к реферату
Приложение Т. Спецификация к чертежам
Приложение У. Спецификация продолжение к чертежам
Приложение Ф. Оформление спецификации к чертежу
Приложение Х. Оформление продолжения спецификации к чертежу
Приложение Ц. Спецификация к схемам
Приложение Ш. Спецификация продолжение к схемам
Приложение Щ. Оформление наклейки на дипломный проект
Приложение Э. Бланк задания на курсовое проектирование
Приложение Ю. Бланк задания на курсовую работу
Приложение Я. Бланк задания на дипломное проектирование
Приложение 1. Бланк задания на дипломную работу
Приложение 2. Рецензия на дипломный проект
Приложение 3. Рецензия на дипломную работу
Приложение 4. Отзыв по дипломному проекту
Приложение 5. Отзыв по дипломной работе
Введение
Нормоконтроль конструкторской и технологической документации проводится для соблюдения в ней норм и требований, установленных стандартами и другими нормативно-техническими документами.
Нормоконтролю подлежит конструкторская и технологическая документация – курсовые и дипломные проекты (работы) студентов колледжа на всех стадиях разработки.
Проведение нормоконтроля направлено на правильность выполнения текстовых и графических документов в соответствии с требованиями стандартов Единой системы конструкторской документации (ЕСКД) и Единой системы технологической документации (ЕСТД).
В процессе нормоконтроля пояснительных записок курсовых и дипломных проектов (работ) проверяется:
- комплектность пояснительной записки в соответствии с заданием на проектирование;
- правильность заполнения титульного листа, наличие необходимых подписей;
- наличие и правильность рамок, основных надписей на всех страницах, выделение заголовков, разделов и подразделов, наличие красных строк;
- правильность оформления содержания, соответствие название разделов и подразделов в содержании соответствующим названиям в тексте записки;
- правильность нумерации страниц, разделов, подразделов, иллюстраций, таблиц, приложений, формул;
- правильность оформления иллюстраций – рисунков, чертежей, схем, графиков;
- правильность оформления таблиц;
- правильность размерностей физических, их соответствие системе интернациональной [1, с. 5];
- отсутствие загромождения записки однотипными расчетами, грамматическими ошибками;
- правильность примененных сокращений слов;
- наличие и правильность ссылок на использованную литературу, правильность оформления литературы.
В процессе нормоконтроля графических документов, курсовых и дипломных проектов (работ) проверяется:
- выполнение чертежей в соответствии с требованиями стандартов;
- соблюдение форматов, правильность их оформления;
- правильность начертания и применение линий;
- соблюдение масштабов, правильность их обозначений;
- достаточность изображений (видов, разрезов, сечений), правильность их обозначения и расположения;
- правильность выполнения схем.
Нормоконтроль является завершающим этапом разработки курсового проекта (работы) и выпускной квалификационной работы.
Нормоконтроль проводится в два этапа:
1 этап – предварительная проверка разрабатываемых документов. При этом документы предъявляют нормоконтролеру с подписями в графах «Разраб.» и «Пров.». При наличии несоответствий выдается лист нормоконтроля с выделенными недостатками;
2 этап – заключительная проверка, несоответствия не допускаются.
Разрабатываемые документы должны предъявляться на нормоконтроль комплектно, т.е. текстовая (пояснительная записка) и графическая документация (чертежи, схемы, спецификации и т.п.).
Нормоконтролер имеет право возвращать разрабатываемую документацию студенту-разработчику без рассмотрения в случаях:
- нарушения установленной комплектности;
- отсутствия обязательных подписей;
- небрежного выполнения [1, с. 6].
Общие положения
Курсовая и выпускная квалификационная работы – важнейшие формы самостоятельной работы студентов. Дипломные работы (проекты) студентов являются законченными научными исследованиями, выполненными на завершающем этапе обучения в колледже. Это творческие работы студентов, главная цель и содержание которых – научные исследования актуальных вопросов теоретического, прикладного или практического характера по профилю специальности.
К защите дипломных проектов (работ) допускаются студенты, полностью выполнившие учебный план.
Тематика дипломных проектов (работ) определяется выпускающими цикловыми комиссиями и утверждается приказом директора в строгом соответствии с квалификационными характеристиками и учетом специализации студентов. Она должна быть связана с решением актуальных научно-исследовательских и организационных задач, затрагивать проблемы народного хозяйства, техники и науки.
Процесс выполнения творческой работы (курсовой, дипломной) включает несколько этапов:
- выбор темы, назначение руководителя;
- изучение требований, предъявляемых к данной работе;
- согласование с руководителем плана работы;
- изучение литературы по проблеме, определение целей, задач и методов исследования;
- непосредственная разработка проблемы (темы);
- обобщение полученных результатов;
- написание работы;
- рецензирование работы;
- защита и оценка работы [1, с. 7].
Единая система конструкторской документации – комплекс государственных стандартов, устанавливающих взаимосвязанные правила и положения о порядке разработки, оформления и обращения конструкторской документации, разрабатываемой и применяемой во всех организациях и учреждениях.
Основное назначение стандартов Единой системы конструкторской документации – установить единые правила выполнения, оформления и обращения конструкторской документации, обеспечивающие:
- возможность взаимообмена конструкторскими документами;
- упрощение форм конструкторских документов и графических изображений;
- механизацию и автоматизацию обработки технических документов и содержащейся в них информации.
К конструкторским документам относят графические и текстовые документы [2, с. 3].
Правила написания и оформления, приведенные в данных методических указаниях, в равной степени могут быть применены к проектам, работам и прочим текстовым документам, выполняемых студентами [1, с. 8].
Правила оформления текстовых документов
Общие требования
Изложение текста и оформление проектов (работ) выполняют в соответствии с требованиями ГОСТ 2.105 [3]. Пример оформления текста приведен в приложении А.
Текст пояснительной записки печатается на одной стороне листа формата А4 (297х210) и должен быть чёрного цвета, в соответствии с ГОСТ 2.301 [4].
На каждом листе выполняется внутренняя рамка, образующая поля слева 20 мм, справа, сверху и снизу – по 5 мм. Пример рамки приведен в приложении Б. Кроме того, на каждом листе, кроме титульного, выполняется основная надпись.
Текст пояснительной записки рекомендуется выполнятьнакомпьютере шрифтом Times New Roman 14. Выравнивание основного текста пояснительной записки оформляется по ширине. В этом случае расстояние между основаниями строк следует принимать равным 1,5 интервалам.
Расстояние от внутренней рамки до границ текста следует оставлять в начале строки не менее 5 мм, а в конце строк – не менее 3 мм [2, с. 4]. Расстояние от верхней или нижней строки текста до верхней или нижней части рамки должно быть не менее 10 мм. Абзацы в тексте начинаются отступом, равным 15 мм от границ текста [3].
Листы пояснительной записки нумеруются сквозной нумерацией арабскими цифрами. Титульный лист является первым листом, задание на проект – вторым, но номера на них не ставятся. На последующих листах ставят порядковые номера в соответствующих графах основных надписей. Приложения также включают в общую нумерацию пояснительной записки [2, с. 4].
Построение документа
Текст пояснительной записки состоит из разделов и подразделов. Это деление увязывается с заданием на проектирование [2, с. 5].
Разделы должны иметь порядковые номера, обозначенные арабскими цифрами без точки и записанные с абзацевого отступа.
Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделённых точкой. В конце номера подраздела точка не ставится [3].
Подразделы также должны быть записаны с абзацного отступа.
Например:
1 Типы и основные размеры
1.1
1.2 Нумерация заголовков подразделов первого раздела
1.3
2 Технические требования
2.1
2.2 Нумерация заголовков подразделов второго раздела
2.3
В учебном документе пункты и подпункты, входящие в состав разделов и подразделов, могут не иметь порядковых номеров.
В тексте могут быть приведены перечисления. Перед каждой позицией перечисления следует ставить дефис или строчную букву, после которой ставится скобка. Для дальнейшей детализации перечислений необходимо использовать арабские цифры, после которых ставится скобка, и запись производится с абзацного отступа, как показано на примере [5, с. 216].
Пример:
а) __________________
б) __________________
1) ________________
2) ________________
в) __________________
Каждый пункт, подпункт и перечисление записывают с абзацного отступа.
Разделы и подразделы должны иметь заголовки. Пункты и подпункты, как правило, заголовков не имеют.
Заголовки должны четко и кратко отражать содержание разделов и подразделов.
Заголовки следует печатать с прописной буквы без точки в конце, не подчеркивая. Переносы слов в заголовках не допускаются. Если заголовок состоит из двух предложений, их разделяют точкой.
Каждый раздел текстового документа рекомендуется начинать с нового листа (страницы) [3].
Расстояние между заголовком раздела (подраздела) и текстом рекомендуют выполнять с пропуском одной строки (два полуторных интервала).
Изложение текста
Изложение материала должно идти от первого лица множественного числа, например: «принимаем», «определяем». Допускается использование неопределённой формы, например: «принимается», «определяется» и т.д. [1, с. 16].
В тексте пояснительной записки не допускается:
1) применять для одного и того же понятия различные научные термины, а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;
2) сокращать обозначения единиц, физических величин, если они употребляются без цифр, кроме единиц физических величин в головках таблиц и в расшифровках буквенных обозначений, входящих в формулы;
3) применять сокращения слов;
4) использовать в тексте математические знаки ≥, ≠, %, № и т.д.;
5) применять индексы стандартов ГОСТ.Р, ОСТ, СЭВ без регистрационного номера [1, с. 17].
Перечень допускаемых сокращений слов установлен в ГОСТ 2.316 [6].
Формулы необходимо набирать в специальной программе (Вставка - объект - Microsoft Equation 3,0). Расстояние от формулы до и после текста рекомендуют выполнять с пропуском одной строки (два полуторных интервала).
Значения символов и числовых коэффициентов, входящих в формулу, должны быть приведены под формулой. Значения каждого символа дают с новой строки в той последовательности, в которой они приведены в формуле. Первая строка в расшифровке формуле должна начинаться со слова «где» без двоеточия после него, например:
(1)
где P – мощность, Вт;
W – работа, Дж;
t – время совершения работы, с.
Все формулы, если их в тексте более одной, нумеруются арабскими цифрами. Номер формулы указывается с правой стороны листа на уровне формулы в круглых скобках. Ссылки в тексте на номер формулы дают в скобках, например: «... в формуле (4)». Нумерация формул может быть сквозная или в пределах раздела, В пределах раздела номер формулы содержит номер раздела и через точку – номер формулы. Например: (2.1) [1, с. 17].
В тексте следует применять стандартизованные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417 [7].
Числовые значения с обозначением единиц физических величин и единиц счета следует писать цифрами, а числа без обозначения единиц физических величин и единиц счета от единицы до девяти – словами.
Примеры:
а) провести анализ пяти проб, каждая весом 25 г;
б) отобрать 15 труб для испытаний на давление.
Не допускается отделять единицу физической величины от числового значения (переносить их на разные строки или страницы), кроме единиц физических величин, помещаемых в таблицах.
Числовые значения величин в тексте следует указывать со степенью точности, которая необходима для обеспечения требуемых показателей, при этом в ряду величин осуществляется выравнивание числа знаков после запятой.
Округление числовых значений величин до первого, второго, третьего и последующих десятичных знаков показателей одного наименования должно быть одинаковым [1, с. 18].
Оформление иллюстраций
Все иллюстрации (фотографии, графики, чертежи, схемы, диаграммы и другие графические материалы) именуются в тексте рисунками [1, с. 18].
Количество иллюстраций должно быть достаточным для пояснения излагаемого текста. Иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его. Иллюстрации должны быть выполнены в соответствии с требованиями стандартов Единой системы конструкторской документации и Системы проектной документации для строительства. Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается «Рисунок 1».
Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: Рисунок А.3.
Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например: Рисунок 1.1.
При ссылках на иллюстрации следует писать «...в соответствии с рисунком 2» при сквозной нумерации и «...в соответствии с рисунком 1.2» при нумерации в пределах раздела.
Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 – Детали прибора [3].
Пример оформления рисунка приведен в приложении В.
Построение таблиц
Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким. Название следует помещать над таблицей.
При переносе части таблицы на ту же или другие страницы название помещают только над первой частью таблицы.
Цифровой материал, как правило, оформляют в виде таблиц в соответствии с рисунком 1.
Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В.
Рисунок 1
Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой.
На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера.
Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.
Таблицы, как правило, ограничивают линиями. Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф по часовой стрелке.
Головка таблицы должна быть отделена линией от остальной части таблицы.
Высота строк таблицы должна быть не менее 8 мм (1,5 интервал).
Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости в приложении к документу.
Допускается помещать таблицу вдоль длинной стороны листа документа.
При необходимости можно сориентировать текст в ячейках таблицы вертикально, для этого изменив направление в тексте на 90о по часовой стрелке.
Если строки или графы таблицы выходят за формат страницы, ее делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют ее головку и боковик. При делении таблицы на части допускается ее головку или боковик заменять соответственно номерами граф и строк. При этом нумеруют арабскими цифрами графы и (или) строки первой части таблицы.
Слово «Таблица» указывают один раз слева над первой частью таблицы, над другими частями пишут слова «Продолжение таблицы» с указанием номера (обозначения) таблицы в соответствии с рисунком 2 [3].
Рисунок 2
Пример оформления таблиц приведен в приложении Г.