Приведем некоторые основополагающие моменты при написании пояснительной записки выпускной квалификационной работы. Ее текст должен быть разделен на разделы, подразделы, пункты. Разделы, подразделы и пункты должны иметь порядковые номера, обозначенные арабскими цифрами. Разделы и подразделы могут состоять из одного или нескольких пунктов. Если раздел состоит из одного подраздела, то подраздел не нумеруется. Отдельные разделы могут не иметь подразделов и состоять непосредственно из пунктов. Если раздел или подраздел имеет только один пункт или пункт имеет только один подпункт, то нумеровать его не следует. Примером оформления разделов и подразделов может служить содержание, приведенное в приложении 6.
Разделы и подразделы должны иметь заголовки. Пункты заголовков не имеют. Заголовки должны четко и кратко отражать содержание разделов и подразделов. В начале заголовка помещают номер соответствующего раздела, подраздела. Если заголовок состоит из двух предложений, их разделяют точкой. Переносы слов в заголовках не допускаются. Каждый раздел печатается с нового листа. Ниже заголовка раздела должна быть оставлена одна свободная строка. Если раздел делится на подразделы, то не должно быть текста между ними.
Текст документа должен быть кратким, четким и не допускать различных толкований. При изложении обязательных требований должны применяться слова «следует», «необходимо», «требуется, чтобы», «разрешается только», «не допускается», «запрещается», «не следует». При изложении других положений следует применять слова: «могут быть», «как правило», «при необходимости», «в случае» и т. д. При этом допускается использовать повествовательную форму изложения текста документа, например, «применяются», «указываются» и т. п. Допускается повествование от третьего лица, например, «применяют», «указывают» и т. д. Не допускается изложение от первого лица «я сделал», «мною выполнено», «нам удалось».
В документах должны применяться научно-технические термины, обозначения и определения, установленные соответствующими стандартами. В случае их отсутствия — общепринятые в научно-технической литературе. В тексте документа не допускается применять: обороты разговорной речи, техницизмы, профессионализмы; произвольные словообразования; сокращения слов, кроме установленных правилами русской орфографии или соответствующими государственными стандартами. Не допускается сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц и в расшифровках буквенных обозначений, входящих в формулы и рисунки.
Оформление технических расчетов. Формулы
Порядок приведения расчетов в текстовом документе определяется характером рассчитываемых величин. Расчеты должны выполняться с использованием единиц СИ. Данные для расчета, в зависимости от их количества, могут быть изложены в тексте или оформлены в виде таблицы. Приступая к расчету, следует указать источник литературы, в соответствии с которым они выполняются.
Расчет, как правило, разделяют на пункты, подпункты или перечисления. Пункты (подпункты, перечисления) расчета должны иметь пояснения, например, «определяем...»; «по графику, приведенному на рисунке 3.4, находим...»; «согласно рекомендациям [4], принимаем...».
Все приведенные в текстовом документе формулы должны быть пронумерованы. Нумерация формул производится арабскими цифрами, которые записываются в круглых скобках справа от формулы без отступа от правого края контура текста страницы. Нумерация может быть либо сквозной в пределах всего документа (например, (1), (2), (3) и т. д.), либо в пределах раздела, в этом случае номер формулы должен содержать номер раздела и порядковый номер формулы внутри раздела (например, (1.1), (1.2) и т. д.). Если в документе только одна формула, то она обозначается (1). Формулы приложений нумеруются в пределах каждого приложения и должны содержать обозначение приложения и порядковый номер формулы внутри приложения (например, (П3.3) — третья формула приложения 3). Ссылки в тексте на формулы даются в скобках (например, «...в формуле (3)...», «...в формуле (4.1)...»).
Оформление иллюстраций
Количество иллюстраций, помещаемых в текстовом документе (схем, диаграмм, графиков, технических рисунков и пр.), должно быть достаточным для пояснения излагаемого текста. Все иллюстрации, помещенные в тексте, именуются рисунками и выполняются с соблюдением стандартов ЕСКД. Рисунок должен быть помещен сразу после ссылки на него в разрывах текста или на отдельном листе того же формата. При необходимости иллюстрации помещают в приложения.
Рисунки снабжаются порядковыми номерами и наименованиями. Под рисунком должны быть помещены пояснительные данные (подрисуночный текст). Ниже пояснительных данных указывают номер рисунка, и через тире приводится название рисунка с прописной буквы. В конце пояснительных данных ставится точка, в конце названия рисунка точка не ставится. Обозначение и наименование рисунка располагается симметрично иллюстрации.
Иллюстрации нумеруются арабскими цифрами сквозной нумерацией по всему тексту документа либо в пределах раздела. Во втором случае номер рисунка должен содержать номер раздела и порядковый номер рисунка внутри раздела, разделенные точкой, например, «Рисунок 1.1», «Рисунок 1.2» и т. д. Если в текстовом документе только один рисунок, то он обозначается «Рисунок 1». На все иллюстрации в тексте должны быть ссылки. При ссылках на иллюстрации следует писать: «...в соответствии с рисунком 2» при сквозной нумерации и «...в соответствии с рисунком 1.2» при нумерации в пределах раздела.
Оформление таблиц
Таблицы применяются для большей наглядности и удобства сравнения показателей. Таблица, в зависимости от ее размера, помещается под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости — в приложении к документу. Допускается помещать таблицу вдоль длинной стороны листа документа.
Таблицы со всех сторон ограничиваются линиями. Головка таблицы, заголовки и подзаголовки граф должны быть отделены линиями от остальной части таблицы. Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается. Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей. Высота строк таблицы должна быть не менее 8 мм.
Слева над таблицей (на уровне левой кромки контура таблицы) помещается слово «Таблица», ее номер и название. Нумерация таблиц производится арабскими цифрами либо сквозной нумерацией в пределах всего текстового документа, например, «Таблица 1» и т. д., либо в пределах раздела. В последнем случае номер таблицы должен содержать номер раздела и порядковый номер таблицы внутри раздела, например, «Таблица 1.1», «Таблица 1.2» и т. д. Если в текстовом документе только одна таблица, то она должна быть обозначена «Таблица 1» или «Таблица 2.1» (в приложении 2). Таблицы приложений нумеруются в пределах каждого приложения и должны содержать номер приложения и порядковый номер таблицы внутри приложения (например, первая таблица приложения 3 «Таблица 3.1»).
На все таблицы в тексте должны быть ссылки. При ссылке следует писать слово «Таблица» с указанием ее номера (например, «в таблице В.3»). Таблица может иметь название (заголовок), которое должно быть точным, кратким и четко отражать ее содержание. Название таблицы помещается над таблицей и оформляется строчными буквами, начиная с прописной. При переносе части таблицы на другие страницы название помещается только над первой частью таблицы, а над следующими частями таблицы пишется «Продолжение таблицы» и указывается ее номер.
Оформление ссылок
В текстовом документе допускаются ссылки на настоящее положение, стандарты, технические условия и другие документы при условии, что они полностью и однозначно определяют соответствующие требования и не вызывают затруднений в пользовании документом. Ссылаться следует на документ в целом или его разделы и приложения. При ссылках на части данного текстового документа указывают номера разделов, подразделов, пунктов, подпунктов, формул, таблиц, рисунков, а при необходимости — также графы и строки таблиц и позиции составных частей изделия на рисунке, чертеже или схеме.
При ссылках на структурный элемент текста, который имеет нумерацию из цифр, не разделенных точкой, указывают наименование этого элемента полностью (например, «...в соответствии с разделом 5», «...по пункту 3»). Ссылки в тексте на таблицы и иллюстрации оформляют по типу: «…в соответствии с таблицей 5.3», «...в соответствии с рисунком 1.2»; «...как показано поз. 12 и 13 на рисунке П2.7 (приложение 2)», «...в таблице 1.1, графа 4», «...в таблице П2.2 (приложение 2)…», причем наименование элемента всегда приводится полностью. Сокращения «табл.» и «рис.» в тексте не допускаются. При ссылках на приложения используют слова: «…в соответствии с приложением__». При ссылке в тексте на использованные источники следует приводить их номера, заключенные в квадратные скобки (например, «...как указано в монографии [103]»; «...в работах [11, 12, 15–17]»). При ссылках на стандарты и технические условия указывают только их обозначение (например, ГОСТ 2.301).
Оформление приложений
Материал, дополняющий содержание выпускной квалификационной работы, допускается оформлять в приложении. В приложении или приложениях могут быть: графические материалы; таблицы большого формата; тексты программ и/или результаты расчета на ЭВМ; описания аппаратуры и приборов; схемы, чертежи и т. п. Если в документе есть приложения, то на них обязательно даются ссылки в основном тексте документа.
Каждое приложение должно начинаться с нового листа с указанием наверху справа страницы слово «Приложение» и на следующей строчке посередине его название. После слова «Приложение» должна следовать буква или цифра, обозначающая его последовательность. Допускается оформлять приложения на листах формата А3. Примеры оформления приложений приведены в данном пособии (см. раздел приложения).