Общие требования к оформлению Документа

Структурные элементы Документа и требования к их содержанию

Введение

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

Выпускник нашего университета обязан владеть приёмами грамотного составления пояснительных записок к научно-техническим, опытно-конструкторским и учебно-исследовательским разработкам (далее – Документов), которые могут быть выполнены в виде рукописи или электронного оригинал-макета. К ним относят:

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

– кандидатскую и докторскую диссертации;

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

– пояснительную записку к курсовому проекту (работе);

– отчёт об учебно-исследовательской работе студентов;

– отчёт о лабораторной работе, производственной практике;

– отчёт о выполнении индивидуального задания по практическому занятию;

– учебный реферат, расчёт.

При составлении таких документов за основу принят ГОСТ 7.32.2001, регламентирующий требования к написанию НИР [1] с нормативными ссылками на ГОСТ 2.105 [2], ГОСТ 2.111 [3], ГОСТ Р 6.38 [4], ГОСТ 7.1 [5], ГОСТ 7.12 [6], ГОСТ 7.54 [7], ГОСТ 7.82 [8], ГОСТ 8.417 [9], ГОСТ 9327 [10]. Кроме того, учтены методические разработки, изданные ранее в нашем университете [11], [12], [13], [14].

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

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

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

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

– отзыв основного руководителя;

– отзыв руководителя от предприятия, направившего студента на учёбу по целевому приёму;

– внешнюю рецензию от предприятия, направившего студента на учёбу по целевому приёму;

– задание;

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

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

– введение;

– основную часть;

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

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

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

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

В пояснительной записке к курсовому проекту (работе) структурными элементами являются:

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

– задание;

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

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

– введение;

– основная часть;

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

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

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

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

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

На титульном листе приводят следующие сведения:

– наименование вуза;

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

– наименование кафедры, ведущей курсовой проект, или выпускающей кафедры;

– вид документа;

– фамилию, имя, отчество студента, его подпись и дату;

– тему проекта (работы);

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

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

– фамилии, инициалы, должности и подписи консультантов по дипломному проекту (работе);

– фамилию, инициалы, должность и подпись лица, осуществляющего нормоконтроль;

– штамп о допуске к защите дипломного проекта студентом Заочного факультета (проставляется деканатом Заочного факультета, заверяется подписью ответственного лица и датой);

– место и год написания Документа.

Образцы титульных листов на выпускную квалификационную работу и курсовой проект приведены соответственно в приложениях А и Б.

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

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

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

Определения, обозначения и сокращения – самостоятельные структурные элементы, которые допускается объединять в один структурный элемент, содержащий перечень определений, обозначений и сокращений, применяемых в Документе. Запись определений, обозначений и сокращений приводят согласно требованиям, приведённым в разделе 4.

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

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

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

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

– анализ литературных источников, освещающих новые современные и прогрессивные технологические решения по рассматриваемым вопросам;

– экономическую оценку эффективности разработок;

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

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

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

Библиографический список должен содержать сведения об источниках литературы, использованных при составлении Документа. Сведения об источниках приводят в соответствии с требованиями ГОСТ 7.1 [5]. Правила оформления библиографического списка рассмотрены в разделе 9.

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

– промежуточные математические доказательства,формулы, расчёты;

– таблицы вспомогательных цифровых данных;

– иллюстрации вспомогательного характера;

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

– описание аппаратуры и приборов (если проводились эксперименты, измерения и испытания);

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

Требования к оформлению приложений приведены в разделе 10.

Изложение текста и оформление Документа выполняют в соответствии с требованиями ГОСТ 7.32-2001 [1], ГОСТ 2.105 [2] и ГОСТ 6.38[1] [4] в рукописном или электронном (с последующей распечаткой на принтере) варианте.

Страницы Документа и включённые в него иллюстрации и таблицы должны быть выполнены на белых листах бумаги формата А4 (210× 297 мм) по ГОСТ 9327 [10] в пределах рабочего поля. Для разворотных таблиц допускается формат А3 (297×420 мм).

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

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

Рукописный текст Документа выполняют чернилами, шариковой или гелиевой ручкой, желательно чёрным цветом. Рисунки допускается выполнять цветными карандашами, шариковыми или гелиевыми ручками или тушью.

Абзацы в рукописных текстах начинают с отступом 15 мм от левого края поля, в остальных –12,7 мм одинаковой величины по всему тексту Документа.

Все листы Документа, на которых имеется какая-либо информация, должны быть пронумерованы постранично арабскими цифрами, соблюдая сквозную нумерацию. На первой странице (титульном листе) номер не проставляют. Номера остальных страниц проставляют нижним колонтитулом в центре нижней части листа без точки. В этом случае оборотная сторона всех листов должна быть пустая. Пустые страницы (лицевые и оборотные) не нумеруют. Иллюстрации и таблицы, расположенные на отдельных листах, включают в общую нумерацию страниц. Иллюстрации и таблицы формата А3 учитывают как одну страницу. Литерная нумерация страниц, например: с. 32а, 32-б, не допускается. Между номером страницы и текстом должен быть межстрочный интервал, соответствующий основному шагу.

В качестве основного шага написания, набора или печати текста может быть использован любой межстрочный интервал, но не менее, мм:

– 5 – для рукописных текстов;

– 3,5 – при печати текстов на принтерных и других наборно-печатающих устройствах.

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

При оформлении текста с помощью компьютера и принтера цвет шрифта должен быть чёрным, высота букв, цифр и других знаков – не менее 1,8 мм (кегль не менее 12).

Основным шрифтом набора текста Документа на клавиатуре наборно-печатающих устройств является Times new Roman. Разрешается использовать компьютерные возможности акцентирования внимания на определённых терминах, формулах, теоремах, а также в заголовках,применяя шрифты разной гарнитуры.

Условные буквенные обозначения механических, химических, математических и других величин должны соответствовать установленным стандартам. В тексте их проставляют без кавычек и скобок. Знаки (буквы, символы, обозначения), отсутствующие на клавиатуре наборно-печатающих устройств, должны вписываться от руки чернилами (пастой) чёрного цвета в оставленное в тексте место. Вписываемые знаки должны иметь размер не меньше использованного в наборе шрифта. Надстрочные и подстрочные индексы, показатели степени могут быть меньших размеров, но не менее 2 мм.

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

– σ («сигма» греч.) – б («бэ» русск.);

– I («и» лат.) – j («иот» лат.);

– ρ («ро» греч.) – р («эр» русск.) и др.

В тексте не допускается:

– применять сокращения слов, которые не установлены правилами русской орфографии и ГОСТ 7.12–93 [6];

– использовать в тексте (вне таблицы) математический знак «–» перед отрицательными значениями величин. Вместо этого знака следует писать слово минус;

– употреблять без чисел математические и другие знаки, например: %, <, >, ≠, ≡, ≤, ≥, ±, §, №, –;

– применять аббревиатуры стандартов (ГОСТ, ОСТ, СТП, СТ) без регистрационного номера.

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

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

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

Пример

а) ____________

б) ____________

1) _______

2) _______

в) ____________

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

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

В аббревиатурах использование кавычек не допускается.

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

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

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

Требования, которые необходимо соблюдать при правке текста, приведены в разделе 11.

Повреждения листов Документа, помарки и следы не полностью удаленного прежнего текста (графики) не допускаются.

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

Сокращение русских слов и словосочетаний в Документе должно соответствовать требованиям ГОСТ 7.12 (см. [6, разд. 4]).

Дата добавления: 2015-06-29