ПРАВИЛА ОФОРМЛЕНИЯ ТЕКСТОВЫХ ДОКУМЕНТОВ
СОДЕРЖАНИЕ
Содержание............................................................................................................. 3
1. Общие положения.............................................................................................. 3
2. Оформление заданий на выполнение проекта (работы)........................ 4
3. Правила оформления текстовых документов............................................ 4
4. Правила оформления графических документов..................................... 12
5. Правила оформления технологических документов............................. 13
6. Правила оформления программных документов................................... 13
Приложения........................................................................................................... 15
Настоящий Руководящий материал устанавливает единые правила и порядок оформления дипломных и курсовых проектов (работ), а также рефератов, контрольных и других работ, отчетов и т.п. учебных документов, выполняемых в процессе освоения основных профессиональных образовательных программ студентами Курганского государственного университета
ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Дипломные проекты и работы являются квалификационными
учебными документами, выполняемыми студентами согласно учебному плану на завершающем этапе обучения.
1.2. Дипломный проект - завершающая процесс обучения квалификационная работа студента, основным содержанием которой является самостоятельное комплексное решение инженерных, организационных, экономических и других задач в соответствии с профилем специальности.
1.3. Дипломная работа - квалификационная комплексная работа
студента, представляющая собой самостоятельное исследование какого-
либо актуального вопроса в области избранного направления (специальности).
1.4. Курсовой проект - самостоятельная работа студента, основной целью и содержанием которой являются развитие умений и навыков путем решения инженерных, организационных, экономических и
других задач по профилю дисциплины учебного плана, а также оформление проектной документации в соответствии с действующими стандартами.
1.5. Курсовая работа - самостоятельная работа студента, основ
ной целью и содержанием которой является развитие навыков выполнения научных исследований теоретического, экспериментального или
практического характера, всестороннего анализа какого-либо актуального вопроса в области изучаемой дисциплины.
1.6. Дипломные и курсовые проекты и работы должны оформляться в соответствии с требованиями государственных стандартов:
- в части содержания основных надписей - по ГОСТ 2.104-68*
(«ЕСКД. Основные надписи»);
- общих требований к текстовым документам - по ГОСТ 2.105-79*
(«ЕСКД. Общие требования к текстовым документам»), ГОСТ 2.106-68*
(«ЕСКД. Текстовые документы»);
- оформление спецификаций - по ГОСТ 2.108-68* («ЕСКД. Спецификация»);
- конструкторские документы - по Единой системе конструкторской документации (ЕСКД);
- технологические документы - по Единой системе технологической документации (ЕСТД);
- программные документы - по Единой системе программной
документации (ЕСПД);
- документы для автоматизированной системы управления - по
Единой системе стандартов автоматизированных систем управления.
2. ОФОРМЛЕНИЕ ЗАДАНИЙ НА ВЫПОЛНЕНИЕ
ПРОЕКТА (РАБОТЫ)
2.1. Устанавливаются следующие формы заданий на проекты
(работы): на дипломный проект и дипломную работу - по обязательному приложению 1; на курсовой проект (работу) – по приложению 2.
2.2. Объем и содержание разделов в заданиях на проектирование
устанавливаются соответствующими кафедрами. Задание на дипломный проект (работу) утверждается руководством факультета.
2.3. Задание на выполнение проекта (работы) брошюруется в
папке текстовых документов после титульного листа и включается в
нумерацию листов проекта (работы).
ПРАВИЛА ОФОРМЛЕНИЯ ТЕКСТОВЫХ ДОКУМЕНТОВ
3.1. Структура текстовых документов
3.1.1. Основным текстовым документом курсового я дипломного проекта (работы) является пояснительная (расчетно-пояснительная) записка. Она должна включать в себя следующее:
- титульный лист;
- задание;
- аннотацию (для дипломных разработок);
- введение;
- основную часть;
- заключение (выводы);
- список использованных источников;
- приложения - при необходимости.
3.1.2. Изменение структуры пояснительной записки дипломного (курсового) проекта устанавливается руководством кафедр.
3.2. Общие требования к оформлению текста.
Текст пояснительной записки должен быть оформлен с учетом соответствующих стандартов - ГОСТ 2.105-79*, ГОСТ 2.106-68*. Ряд конкретных рекомендаций представлен ниже.
3.2.1. Пояснительная записка к проекту (работе) выполняется на
светлой (белой) бумаге и брошюруется в папку формата А4. На папку
должна быть наклеена этикетка (60x100 мм) с указанием аббревиатуры
вуза, вида документа, кода учебной группы и специальности, автора
проекта (работы) и года окончания выполнения данной разработки,
приложение 3.
3.2.2. Титульный лист должен быть выполнен по соответствую
щей форме: дипломный проект - приложение 4, дипломная работа -
приложение 5; курсовой проект - приложение 6; курсовая работа -
приложение 7. Перенос слов на титульном листе не допускается.
Уточнение (расчетно-пояснительная, пояснительная записка) указывают по необходимости, с учетом специфики выполненной работы.
Наименование дисциплины указывают в соответствии с учебным планом.
Направление (для бакалавра), либо специальность (для специалиста) указывают полным наименованием и в скобках -кодом.
В приложениях 8, 9 приведены примеры заполнения отдельных титульных листов.
3.2.3. Текст следует оформлять с соблюдением следующих размеров полей: левое - 20 мм, правое -10 мм, верхнее - 15мм, нижнее - 20мм. Абзацы в тексте начинают отступом в 15... 18 мм. Рамки на листах расчетно-пояснительной записки не требуются.
3.2.4. Текст следует выполнять рукописно чернилами синего,
фиолетового или черного цвета, а также машинописно, в том числе с применением печатающих и графических устройств вывода ЭВМ.
3.2.5. При машинописном исполнении текста вписывать в него
отдельные слова, формулы, условные знаки и т.п. следует черными
чернилами (тушью, пастой).
3.2.6. Опечатки, описки и графические неточности, обнаруженные в процессе выполнения документа, допускается исправлять заклеиванием, подчисткой или закрашиванием с последующим нанесением на том же месте исправленного текста (графика) черными чернилами (пастой, тушью).
3.2.7. Распечатки с ЭВМ должны оформляться по ГОСТ 7.32 -91
(«Отчет о научно-исследовательской работе»).
3.3. Построение текста документов
3.3.1. Текст документа при необходимости разделяют на разделы, подразделы, пункты и подпункты, что обеспечивает его четкую
структурированность.
3.3.2. Разделы должны иметь порядковую нумерацию в пределах
всего документа (используются арабские цифры с точкой). Подразделы
должны иметь порядковую нумерацию в пределах каждого раздела.
Пункты, в свою очередь, нумеруются по порядку в пределах подраздела,
а подпункты нумеруются в пределах пункта.
Текст в целом может быть структурирован следующим образом:
1. ПЕРВЫЙ РАЗДЕЛ
1.1. Первый подраздел раздела 1.
1.1.1. Первый пункт подраздела 1.1.
1.1.1.1. Первый подпункт пункта 1.1.1.
2. ВТОРОЙ РАЗДЕЛ
2.1. Первый подраздел раздела 2.
2.4.1.3. Третий подпункт первого пункта четвертого
подраздела второго раздела
5. ПЯТЫЙ РАЗДЕЛ и т.д.
3.3.3. Такие части текстового документа как СОДЕРЖАНИЕ,
ПЕРЕЧЕНЬ УСЛОВНЫХ ОБОЗНАЧЕНИЙ, ВВЕДЕНИЕ, ЗАКЛЮЧЕ
НИЕ, СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ являются его
6
разделами и обозначаются соответствующими заголовками, но без нумерации.
3.3.4. Содержащиеся в тексте пункта или подпункта перечисления требований, условий, указаний, положений обозначают арабскими цифрами со скобкой, например: 1), 2), 3) и т.д.
3.3.5. Каждый пункт, подпункт и перечисления записывают с
красной строки.
3.3.6. Наименования разделов и подразделов должны быть краткими. Наименование разделов записывают в виде заголовков (симметрично тексту) прописными буквами. Наименование подразделов, пунктов и подпунктов записывают в виде заголовков (с абзаца) строчными буквами (кроме первой прописной).
Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят. Если заголовок состоит из двух предложений, их разделяют точкой.
Расстояние между заголовками и текстом должно составлять не менее 15 мм. Расстояние между заголовками раздела и подраздела 7... 10 мм.
3.4. Изложение текста документов
3.4.1. Текст документа должен быть кратким, четким и не до
пускать различных толкований.
При изложении обязательных требований в тексте должны применяться слова «должен», «следует», «необходимо» и производные от них.
В документах должны применяться научные, научно-технические термины, обозначения и определения, установленные соответствующими стандартами, а при их отсутствии - общепринятые в научной, научно-технической литературе.
Если в документе принята специфическая терминология, то в конце его (перед списком литературы) должен быть приведен перечень принятых терминов с соответствующими разъяснениями. Перечень включают в содержание документа.
3.4.2. В тексте документа не допускается:
1) применять для одного и того же понятия различные научные,
научно-технические термины, близкие по смыслу (синонимы), а также
иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;
2) применять сокращения слов, кроме установленных правилами
орфографии, пунктуации, а также стандартами;
3) употреблять математические знаки без цифр, например: ≤(меньше или равно), ³ (больше или равно), ≠(не равно), а также знаки № (номер), % (процент).
3.4.3. Условные буквенные обозначения величин, а также условные графические обозначения должны соответствовать установленным стандартам. В тексте документа перед обозначением параметра дают его пояснение, например: «Коэффициент трения скольжения f».
3.4.4. В тексте документа числа с размерностью следует писать
цифрами, а без размерности - словами, например: «Зазор - не более 2
мм», «Катушку пропитать два раза».
3.4.5. Единица измерения физической величины одного и того
же параметра в пределах одного документа должна быть постоянной.
При этом надлежит использовать систему СИ.
3.4.6. При использовании в текстовом документе формул следует придерживаться определенных правил.
3.4.6.1. Все формулы записываются отдельной строкой с абзаца
и интервалом 7...10 мм от предыдущего и последующего текста.
3.4.6.2. Значения символов и числовых коэффициентов, входящих в формулу, должны быть раскрыты по тексту перед формулой или перечислены непосредственно после нее. Перечисление символов после формулы должно начинаться со слова «где». В этом перечислении могут быть приведены значения величин с указанием единиц измерения.
3.4.6.3. Для результата расчета по формуле единицы измерения
(в системе СИ) указываются обязательно.
3.4.6.4. При необходимости ссылки в тексте документа на какую-либо формулу ее следует нумеровать арабскими цифрами в скобках. Нумерация формул может быть сквозная в пределах каждого раздела или по всему документу. Номер указывают с правой стороны листа на уровне формулы. Например, вторая формула третьего раздела может быть записана так:
 |
(3.2)
где U - касательные напряжения, МПа;
Т - крутящий момент на валу, Нмм ;
Wp- полярный момент сопротивления сечения вала, мм3. Пример записи формулы с предварительной расшифровкой составляющих приведен ниже:
Основное время на переход То (мин) определяется с учетом длины рабочего хода Lpx (мм) и минутной подачи Sm (мм/мин):
(2.4)
3.4.7. В текстовых документах ссылки на используемые источники оформляются с указанием номера источника по списку (см.п.3.8.), выделенного двумя косыми чертами. Например: «... В работе /4/ приведены основные...».
В рамках ссылки на источник целесообразна ее детализация в части указания раздела, подраздела, таблицы, иллюстрации и т.п. Например: «... данная величина определена по справочно-нормативной
литературе / 12, раздел 3, табл. 3.7 /...».
3.5. Оформление иллюстраций
3.5.1. Количество иллюстраций должно быть достаточным для
пояснения излагаемого текста. Иллюстрации могут быть расположены
по тексту документа или даны в приложении.
3.5.2. Все иллюстрации, если их в документе более одной, нумеруют в пределах раздела арабскими цифрами. Номер иллюстрации состоит из номера раздела и порядкого номера иллюстраций, разделенных точкой, например: Рис. 1.1., Рис. 12.6.
Допускается нумерация иллюстраций в пределах всего документа.
3.5.3. Ссылки на иллюстрации дают по типу: «рис. 1.1». Ссылки
на ранее приведенные иллюстрации дают сокращенным словом «смотрю), например: «см.рис. 3.2.»
3.5.4. Иллюстрации, при необходимости, могут иметь наименование и поясняющие данные (подрисуночный текст). Наименование помещают над иллюстрацией, поясняющие данные - под ней. Номер ил
люстрации помещают ниже поясняющих данных.
3.5.5. Если в тексте документа есть ссылки на составные части
изделия, то на иллюстрации должны быть указаны номера позиций этих
составных частей.
При ссылке в тексте на отдельные элементы деталей (отверстия, пазы и др.) их обозначают прописными буквами русского алфавита. Пример исполнения иллюстрации приведен в приложении 10.
3.6. Построение таблиц
3.6.1. Цифровой материал, как правило, оформляют в виде таблиц.
Таблица может иметь заголовок, который следует выполнять строчными буквами (кроме первой прописной) и помещать над таблицей. Заголовок должен быть кратким и полностью отражать содержание таблицы.
Высота строк таблицы должна быть не менее 8 мм.
3.6.2. Все таблицы, если их в документе более одной, нумеруют
в пределах раздела арабскими цифрами. Номер таблицы состоит из
номера раздела и порядкового номера таблицы, разделенных точкой.
Допускается сквозная нумерация таблиц в тексте.
Над правым верхним углом таблицы помещают надпись «Таблица..» с указанием номера таблицы, например: «Таблица 2.1.»
При наличии заголовка надпись «Таблица...» пишут выше заголовка.
На все таблицы должны быть ссылки в тексте, при этом слово «таблица» в тексте пишут полностью, если таблица не имеет номера, и сокращенно - если имеет номер, например: «... в табл. 1.1.». Если в документе только одна таблица, то номер ей не присваивается и слово «Таблица» не пишут.
3.6.3. Если строки или графы выходят за формат листа, таблицу
делят на части, которые в зависимости от особенностей таблицы переносят на другие листы или помещают на одном листе рядом, или одну под другой.
При переносе части таблицы на другой лист заголовок помещают только над первой частью.
Слово «Таблица», порядковый номер таблицы и заголовок (при его наличии) указывают один раз над первой частью таблицы, над последующими частями пишут слово «Продолжение» или, например, «Продолжение табл. 2».
3.6.4. Графу «№ п/п» в таблицу не включают. Для облегчения
работы с табличным материалом и для ссылок в тексте на данные таблицы целесообразна нумерация ее граф и строк.
3.6.5. Если цифровые данные в графах таблицы выражены в раз
личных единицах физических величин, то их указывают в заголовке
каждой графы. Если все параметры, размещенные в таблице выражены
в одной и той же единице физической величины, например, миллиметрах, сокращенное обозначение единицы физической величины помещают над таблицей, например «Размеры болтов, мм».
3.6.6. Повторяющийся в графе таблицы текст, состоящий из одного слова, допускается заменять кавычками, если строки в таблице не разделены линиями.
Если повторяющийся текст состоит из двух и более слов, то при первом повторении его заменяют словами «То же», а далее - кавычками.
Ставить кавычки вместо повторяющихся цифр, марок, знаков и химических символов не допускается.
Если цифровые или иные данные в таблице не приводят, то в графе ставят прочерк.
3.6.7. Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например: D - диаметр, Н - высота, L - длина.
3.7. Оформление приложений
3.7.1. Иллюстрационный материал, таблицы, листы спецификаций
или текст вспомогательного характера допускается давать в виде приложений.
Приложение оформляют как продолжение данного документа на последующих его листах или выпускают в виде самостоятельного документа.
Каждое приложение должно начинаться с нового листа (страницы) с указанием в правом верхнем углу первого листа слова «ПРИЛОЖЕНИЕ» прописными буквами. Рекомендуется давать приложению краткий заголовок
3.7.2. При наличии в документе более одного приложения, их
нумеруют арабскими цифрами, например: ПРИЛОЖЕНИЕ 1.
3.7.3. Если в документе есть приложения, то на них дают ссылку
в основном тексте документа, а в содержании перечисляют все приложения с указанием их номеров и заголовков (при наличии).
3.8. Оформление списка использованных источников
3.8.1. Общие требования к библиографическому описанию источника и правила составления библиографического описания представлены в ГОСТ 7.1.-84 ("Библиографическое описание документа. Общие требования и правила составления").
3.8.2. Список использованных источников оформляется в по
рядке появления ссылок на них в тексте документа или по алфавиту.
Пример списка использованных источников приведен в приложении 11.
3.8.3. Наряду с составлением общего списка можно приводить библиографическое описание отдельных источников в подстрочных примечаниях к основному тексту.