Пояснительная записка дипломного проекта должен быть оформлена в соответствии с ГОСТ 2.105-95* «ЕСКД. Общие требования к текстовым документам» и отпечатана на принтере с одной стороны листа белой односортной бумаги формата А4 (210×297 мм) с нанесённой ограничительной рамкой.
Лист пояснительной записки должен иметь следующие размеры полей: верхнее – 10 мм, нижнее – 25 мм, левое – 25 мм, правое – 10 мм. При этом отступ текста относительно внутренней границы рамки будет составлять 5 мм.
Первый лист содержания пояснительной записки должен соответствовать форме 9 ГОСТ 2.106-96 «ЕСКД. Текстовые документы» (см. также рис. Ж.1 в приложении Ж) с основной надписью (штампом) по форме 2 ГОСТ 2.104-2006 «ЕСКД. Основные надписи» (см. также рис. И.1 в приложении И), а все последующие листы записки – форме 9а (рис. Ж.2) с основной надписью по форме 2а (рис. И.2). В графе 1 основной надписи пишется «Пояснительная записка» (без кавычек), в графе 7 указывается номер листа – 5, а в графе 8 – число листов в пояснительной записке, подсчитанное без учёта приложений. Основная надпись выполняется специальным компьютерным шрифтом – аналогом чертёжного шрифта типа А или Б (с наклоном) по ГОСТ 2.304-81 «ЕСКД. Шрифты чертёжные».
Также допускается использование формы 9 для каждого раздела основной части пояснительной записки. В этом случае разделу предшествует заглавный лист с основной надписью по форме 2. В его центре прописными буквами пишется слово «раздел» с указанием номера раздела, а в графе 1 основной надписи приводится наименование раздела. В графе 7 основной надписи указывается порядковый номер этого листа в пояснительной записке, а в графе 8 – число страниц в разделе. Текст раздела начинается со следующего листа, в первой строке которого указывается номер и заголовок раздела.
Каждому дипломному проекту присваивается обозначение, состоящее из
− индекса, указывающего на вид квалификационной работы (дипломный проект – ДП),
− аббревиатуры университета,
− шифра специальности («Информационные системы и технологии» – 230201.65),
− номера студенческого билета (или, то же самое, зачётной книжки),
− года защиты проекта.
Все элементы обозначения разделяются дефисом.
Например: ДП-УлГТУ-23020165-03/123-2009.
Обозначение указывается в графе 2 основной надписи с добавлением аббревиатуры пояснительной записки, например: ДП-УлГТУ-23020165-03/123-2009 ПЗ.
Текст пояснительной записки разбивается на разделы, подразделы, пункты и подпункты. Наименования их заголовков должны быть краткими. Переносы слов в заголовках не разрешаются. Если заголовок состоит из двух и более предложений, то они разделяются точкой. Точку в конце заголовка не ставят.
Подчеркивание наименований заголовков, заключение их в кавычки не допускается. Дополнительный интервал от текста (сверху) до заголовка должен составлять: для раздела – 30 пт, для подраздела – 24 пт, для пункта и подпункта – 18 пт; дополнительный интервал между заголовками разных уровней – 12 пт, от заголовка до текста (снизу) – 12 пт. При оформлении заголовков также следует использовать следующие параметры (табл. 6.1).
Каждый раздел должен начинаться с нового листа, как и остальные структурные части записки: содержание, список использованных сокращений и обозначений и др. Не разрешается размещать заголовки в нижней части страницы, если на ней не помещается более двух-трёх строк последующего текста.
Разделы нумеруются арабскими цифрами в пределах всей пояснительной записки. Подразделы должны иметь нумерацию в пределах каждого раздела.
Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. Например, раздел 1.2 – второй подраздел первого раздела. Пункты нумеруются в пределах подраздела, подпункты – в пределах пункта. Номер пункта образуется из номера подраздела и порядкового номера пункта, разделённых точкой (к примеру, пункт 2.1.5 – пятый пункт первого подраздела второго раздела), подпункта – из номера пункта и порядкового номер подпункта, разделённых точкой (например, 1.1.1.1). В конце номера раздела, подраздела, пункта и подпункта точка не ставится.
Структурные части записки «Аннотация», «Содержание», «Список использованных сокращений и обозначений», «Введение», «Заключение», «Список использованных источников» не нумеруют.
Первым листом пояснительной записки дипломного проекта является титульный лист. Нумерация листов должна быть сквозной для всего документа, включая приложения. Таблицы и иллюстрации, расположенные на отдельных листах, также включаются в общую нумерацию. Номера листов на титульном листе, листах задания по дипломному проекту, аннотации не ставятся, но учитываются при подсчёте. Первый лист содержания, начиная с которого начинает проставляться нумерация, имеет пятый номер.
На четвёртом листе пояснительной записки размещается аннотация. Лист аннотации не имеет ограничительной рамки. Оформление текста аннотации должно соответствовать требованиям ГОСТ 7.9-95 «СИБИД. Реферат и аннотация. Общие требования». В частности, в аннотации не допускается применение необщепринятых терминов и сокращений.
Образец оформления аннотации приведён в приложении В.
Приложения оформляются как продолжение пояснительной записки, но при подсчёте листов не учитываются. Каждое приложение следует начинать с нового листа. В первой строке прописными буквами указывается слово «приложение», его обозначение и выравнивается по правому краю листа. Приложения обозначают заглавными буквами русского алфавита, начиная с А (предпочтительный вариант), за исключением букв Ё, 3, Й, О, Ч, Ь, Ы, Ъ, или латинского алфавита, за исключением букв I и О. Приложение должно иметь заголовок, который записывается прописными буквами отдельной строкой с выравниванием по центру.
В тексте пояснительной записки на все приложения должны быть даны ссылки, например, «представлены в приложении А». Приложения располагают в порядке ссылок на них в тексте. Все приложения должны быть перечислены в содержании пояснительной записки с обозначениями и наименованиями.
Если в качестве приложения используется реальный документ или бланк, его вкладывают в записку без изменений. Листы, на которых он размещён, включают в общую нумерацию, но не нумеруют. При необходимости отдельные элементы документа могут быть забелены (белилами типа «штрих»). Приложения, состоящие из таких документов, должны идти после всех остальных приложений. Их обозначения и наименования приводятся в только содержании записки.
В содержание включаются заголовки только тех структурных частей записки, которые расположены после него. Заголовки одинаковых ступеней рубрикации следует располагать друг под другом. Заголовки каждой последующей ступени смещают на три-пять знаков вправо по отношению к заголовкам предыдущей ступени. Все заголовки должны состоять из прописных букв или начинаться с прописной буквы – в соответствии с тем, как они оформлены в тексте. Последнее слово каждого заголовка соединяют отточием с соответствующим ему номером страницы в правом столбце.
Целесообразно формировать содержание средствами текстового редактора на основе стилей заголовков. При этом все указанные выше рекомендации могут быть выполнены автоматически.
При оформлении текста записки следует использовать следующие параметры (табл. 6.2).
Отдельные слова или словосочетания могут быть выделены стилем шрифта (курсивом, полужирным начертанием, подчёркиванием), если на них требуется акцентировать внимание. В случае необходимости могут выделяться одно или несколько предложений. Но злоупотреблять этими средствами не следует.
Если в тексте приводятся надписи, используемые, к примеру, в интерфейсе программного обеспечения, их выделяют стилем шрифта без употребления кавычек. Например: «…в меню Файл », «… предназначена кнопка Выполнить расчёт ». Но тексты сообщений, наименования режимов (и т. д.) обрамляются кавычками, например, «… выводится сообщение «Расчёт выполнен». Следует применять только угловые кавычки («, »). Обычные кавычки могут использоваться лишь в английских текстах.
Для выделения объединённых по смыслу частей длинного текста он разбивается на абзацы. Число предложений в абзаце обычно колеблется от двух до пяти-шести. Абзацный отступ должен быть одинаковым в пределах всей записки.
Фамилии, названия предприятий и другие имена собственные приводятся в тексте записки на языке оригинала. Допускается транскрибировать имена собственные или переводить их на русский язык (за исключением фамилий) с добавлением при первом упоминании оригинального названия.
Дефис (короткая чёрточка) применяется в основном для разделения частей сложных слов и никогда не отделяется пробелами. Тире (длинная чёрточка) – знак препинания, используемый в предложениях. Тире всегда отделяется пробелами с двух сторон, но не переносится так, чтобы с него начиналась новая строка (поэтому перед тире лучше ставить «неразрывный» пробел, если это позволяет текстовый редактор). Пробелом не отделяются от чисел знаки процента и градуса, показатели степени. Не ставится пробел перед закрывающей и после открывающей скобок. После знака номера пробел следует ставить. После любого знака препинания ставится пробел.
При необходимости внесения в текст небольших изменений, обнаружении опечаток допускается забеливание ошибочного текста и выполнение на том же месте исправлений рукописным способом или наклейка полосок бумаги с напечатанным правильным текстом. Не должно быть повреждений листов, помарок и следов прежнего текста.
Пояснительная записка является техническим документом, поэтому следует избегать употребления в её тексте обращений от первого лица (не «я выбрал», а «было выбрано»), оборотов разговорной речи, предложений с восклицательными знаками и т. п. При изложении обязательных требований следует применять слова «должен», «следует», «необходимо», «обеспечить» и т. п., при изложении менее категоричных положений – слова «могут быть», «как правило», «при необходимости», «в случае» и т. д.
В пояснительной записке дипломного проекта не следует:
− применять техницизмы и профессионализмы, произвольные словообразования,
− применять различные термины для одного и того же понятия, иностранные слова и термины при наличии равнозначных в русском языке,
− допускать грамматические, пунктуационные, стилистические ошибки и опечатки,
− использовать для оформления текста какой-либо другой цвет, кроме чёрного.
В пояснительной записке дипломного проекта собственные сокращения, как правило, вводить не требуется, но могут использоваться общепринятые сокращения, применяемые при записи единиц измерения, а также грамматические сокращения, в том числе:
− после перечисления: и т. д. (и так далее), и т. п. (и тому подобное), и др. (и другие), и пр. (и прочие);
− при пояснении: т. е. (то есть);
− при ссылках: см. (смотри), ср. (сравни), напр. (например);
− при цифровом обозначении веков и годов: в. (век), вв. (века), г. (год), гг. (годы).
Запрещается применять сокращенные обозначения единиц измерения (в том числе денежных), если они употребляются без цифр, за исключением использования сокращений в таблицах и расшифровках формул. Сокращения типа «и др.» ставятся только перед знаком препинания или закрывающей скобкой, в середине текста их нужно записывать полностью или в скобках. В конце части общеупотребительных сокращений (м, г) принято точку не ставить.
В отличие от сокращений, обозначения (в частности, аббревиатуры) приходится вводить почти в каждом объёмном техническом тексте, в том числе и в пояснительной записке дипломного проекта. Обозначение, встречающееся в тексте в первый раз, указывается в скобках, сразу за его расшифровкой, например, «... может применяться генетический алгоритм (ГА)». Далее по тексту обозначение употребляется уже без скобок. Допускается приводить расшифровку одного и того же обозначения в каждом из разделов записки.
Используемые сокращения и обозначения включаются в «Список использованных сокращений и обозначений».
При изложения большого числа однородных фактов в тексте можно использовать перечисления (списки), причем сразу после заголовка (без вводного предложения, которое предшествует перечислению) они не допускаются. Перед перечислением ставится двоеточие. Все элементы перечисления должны грамматически подчиняться вводному предложению.
Перечисления могут быть маркированными, нумерованными или буквенными.
Элементы маркированных списков с текстовыми фрагментами из нескольких предложении следует начинать с прописной буквы и в конце фрагментов ставить точку. При мелких, например, однострочных элементах перечислений, их следует начинать со строчной буквы и заканчивать точкой с запятой. Если элементы перечисления не имеют внутренних знаков пунктуации, например, содержат по одному слову или слову с определением, их можно разделять запятой.
Хотя при использовании текстового редактора роль маркера может выполнять произвольный символ, в пояснительной записке для поддержания строгого стиля оформления следует использовать только тире.
В нумерованных списках с крупными текстовыми фрагментами используются арабские цифры с точкой, после которой текст начинается с прописной буквы и завершается точкой. Если перечисление состоит из коротких элементов, они нумеруются арабскими цифрами со скобкой, начинаются со строчной буквы и разделяются точкой с запятой или запятой. Использование римских цифр не допускается. Аналогично, в буквенных списках в первом случае роль идентификатора элемента списка играют прописные буквы с точкой после них, а во втором – строчные буквы со скобкой.
Перечисления, элементы которых не содержат отдельных предложений, могут включаться в состав абзаца. Например, «оперативная память в системах с массовым параллелизмом имеет трёхуровневую структуру: 1) кэш-память процессора, 2) локальная оперативная память узла, 3) оперативная память других узлов».
Объёмный цифровой материал, а также многомерный текстовой материал должен оформляться в виде таблиц. Эта форма представления весьма информативна и при этом позволяет значительно экономить место.
Таблица со всех сторон, как правило, ограничивается линиями. «Шапка» таблицы также должна быть отделена линией от остальной части таблицы. Горизонтальные и вертикальные линии, разграничивающие строки и столбцы таблицы, допускается не проводить, если это не затрудняет изучение таблицы.
Использовать диагональные разделяющие линии в таблице недопустимо.
Таблицу следует располагать в документе непосредственно после текста, в котором она упоминается впервые. При необходимости, допускается вертикальное размещение таблицы. В этом случае она помещается на следующем после ссылки листе, причём шапка таблицы должна находиться с левого края листа.
Заголовки и подзаголовки граф выравниваются по центру соответствующий графы. Они, как правило, записываются параллельно строкам таблицы, но также допускается их перпендикулярное расположение, если параллельная запись затруднительна. Заголовки и подзаголовки граф указывают в единственном числе.
Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком. В конце заголовков и подзаголовков точка не ставится. Обозначение единицы измерения, общей для всех данных в графе или строке, следует указывать через запятую вслед за заголовком графы или строки.
Если таблица текстовая, то текст в ячейках таблицы всегда начинается с прописной буквы без точки в конце. Однако все промежуточные знаки препинания проставляются, в том числе и точки между предложениями. Текстовое значение записывается на уровне первой строки наименования показателя. Числовое значение показателя проставляется на уровне последней строки наименования показателя. При этом числа должны располагаться так, чтобы цифры одного разряда во всей графе были расположены точно друг под другом. Числовые величины в одной графе должны иметь одинаковое количество десятичных знаков.
Если параметры одной графы имеют одинаковые значения в двух и более строках, то допускается объединение соответствующих ячеек данной графы в одну ячейку и проставление параметра один раз. То же относится и к одинаковым значениям параметра в одной строке. Если данные в ячейке не приводятся, в ней ставится прочерк (тире).
Таблицы нумеруются в пределах раздела арабскими цифрами. Номер таблицы состоит из номера раздела и порядкового номера таблицы, разделённых точкой. Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой буквенного обозначения приложения.
Над левым верхним углом таблицы помещается надпись «Таблица» с указанием номера таблицы, например, «Таблица 6.1». Дополнительный интервал перед этой строкой должен составлять 12 пт. При наличии тематического заголовка его помещают над таблицей в следующей строке и выравнивают по
центру. Точка в конце заголовка таблицы не ставиться. Дополнительный начальный интервал для абзаца, следующего после таблицы, должен быть равен 18 пт.
Если строки или графы таблицы выходят за формат листа, таблицу делят на части, помещая одну часть под другой. И в каждой части таблицы повторяют её шапку и боковик (первую графу). При этом во второй и последующих частях
допускается замена шапки и боковика таблицы соответственно номерами граф
и строк. Также нумерация граф или строк производится, если на них имеются
ссылки в тексте. Номера граф задаются отдельной строкой сразу после шапки
таблицы, номера строк – первой графой. При необходимости нумерации пока-
зателей, параметров или других данных порядковые номера следует указывать
в боковике таблицы непосредственно перед их наименованием, не используя
отдельную графу.
Если таблица занимает несколько листов пояснительной записки, то в начале каждого листа, на котором продолжается таблица, рекомендуется добавлять строку с записью «Продолжение табл.», выровненной по правому краю, и указывать номер таблицы, например, «Продолжение табл. 6.1». Название таблицы при этом не повторяется.
Если все показатели, приведённые в графах таблицы, выражены в одной и той же единице измерения, то её обозначение следует помещать непосредственно над таблицей справа, например, «Длительность в секундах». При делении таблицы на части это обозначение указывается над каждой её частью.
Иллюстрации должны наглядно дополнять и подтверждать изложенный в тексте материал. Это могут быть схемы, графики, диаграммы, графические изображения, в том числе и цветные.
Иллюстрации нумеруются арабскими цифрами в пределах раздела. Допускается не нумеровать мелкие иллюстрации, размещенные непосредственно в тексте и на которые в дальнейшем нет ссылок. Номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации в разделе, разделенных точкой. Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой буквенного обозначения приложения. При необходимости, под иллюстрацией помещают поясняющие данные (подрисуночный текст). Номер и наименование иллюстрации (подпись) помещаются под её изображением, если поясняющих данных нет, или после поясняющих данных, при их наличии, и выравниваются по центру строки. Пример подписи иллюстрации: «Рисунок 3.1 - ER-диаграмма логической модели данных». Допускается также размещать подрисуночный текст и после названия, например, в одной строке с ним через точку, двоеточие или в скобках.
Дополнительный интервал между текстом (сверху) и иллюстрацией, между подписью иллюстрации и текстом (снизу) – 12 пт, между иллюстраций и её подписью – 6 пт.
Как и таблицы, иллюстрации следует размещать сразу после ссылки на них в тексте.
При переносе объёмной иллюстрации на следующий лист (в исключительных случаях) её наименование не повторяется, однако ниже указывается номер иллюстрации со словом «продолжение», например, «Продолжение рис. 3.1».
Иллюстрации, размещаемые на отдельном листе, могут иметь как вертикальную, так и горизонтальную ориентацию.
Включаемые в записку большие иллюстрации, при необходимости, могут оформляться в составе приложений на форматах, больших A4 (по ГОСТ 2.301-68 «ЕСКД. Форматы»), складываемых до размера формата записки.
Небольшие и не имеющие особого значения формулы можно размещать непосредственно в строке текста, а объёмные, достаточно важные формулы, на которые будут делаться ссылки, следует выделять в отдельную строку. В этом случае формулы размещают с абзацного отступа или выравнивают по центру, отделяя от текста снизу и сверху дополнительным интервалом в 6 пт.
Формулы должны создаваться средствами редактора формул, встроенного в используемый текстовый редактор или внешнего.
Формулы, следующие одна за другой и не разделённые текстом, отделяют друг от друга запятой. При написании формул, не помещающихся по ширине листа, их разделяют на две, три и более строк. Перенос допускается только на знаках равенства, сложения, вычитания, деления и умножения. При переносе эти знаки повторяются в конце и начале строк. При переносе формулы на знаке умножения применяют знак «×».
Формулы, на которые имеются ссылки в тексте, последовательно нумеруются, те же формулы, на которые ссылок нет, нумеровать не нужно. Номер формулы состоит из номера раздела и порядкового номера формулы в пределах раздела, разделенных точкой. В приложениях формулы нумеруются в пределах каждого приложения с добавлением буквенного обозначения приложения. Каждый номер должен быть заключён в скобки и помещён с правой стороны листа на нижней строке формулы.
Расшифровка значений символов и числовых коэффициентов должна приводиться непосредственно под формулой в той последовательности, в какой они следуют в формуле. При этом значение каждого символа и каждого числового коэффициента следует давать с новой строки (абзацем). Первую строку начинают со слова «где» без двоеточия после него. Пояснение для того или иного символа или коэффициента не даётся, если оно уже было сделано ранее в этом разделе (для другой формулы или в тексте).
Производные от приведённой ранее основной формулы можно обозначать, используя номер основной формулы с добавлением строчной буквы русского алфавита, которая пишется слитно с номером, например, (6.1а).
Математические знаки («+», «-», «=», «>», «<» и др.) используются только в формулах, в тексте их следует писать словами. Знаки «№», «%», «°» применяются только вместе с цифрами. В тексте они также записываются словами.
При размещении в записке цифрового материала должны использоваться только арабские цифры, за исключением нумерации кварталов, полугодий и т. п., которые традиционно обозначаются римскими цифрами.
Числа с размерностью следует писать цифрами, а без размерности – словами. Например: «не более 2,5 сек.», «время уменьшится в два с половиной раза». Если приводится ряд величин одной и той же размерности, то единица измерения указывается только после последнего числа. Аналогично, знаки номера, градуса, процента пишутся только один раз, соответственно, при первой или последней цифре. Например: «№ 2, 3, 5, 9», «7; 10; 12°». Для величин, составляющих диапазон, единица измерения пишется только один раз при второй цифре, к примеру: «3-5 см», «от 3 до 5 см».
Недопустимо отделять единицу измерения от числового значения (переносить её на следующую строку).
Примечания используются, если необходимы пояснения или справочные данные к содержанию текста, таблицы или иллюстрации. Их следует помещать непосредственно после материала, к которому они относятся. Примечания не должны содержать требования.
Слово «примечание» пишется с прописной буквы с абзацного отступа и выделяется полужирным стилем шрифта. После слова «примечание» ставится точка и приводится текст примечания, начинающийся с прописной буквы. Для записи примечаний целесообразно использовать кегль шрифта 12. Например: Примечание. Текст примечания.
Если примечаний несколько, то они записываются со следующей строки и нумеруются арабскими цифрами. Например:
Примечания:
1. Текст первого примечания.
2. Текст второго примечания.
Примеры полезны в тех случаях, когда они могут пояснить приводимый в тексте записки материал или способствуют более краткому его изложению.
Примеры, если они не являются составной частью предложения или абзаца, размещают, оформляют в целом так же, как и примечания, однако кегль шрифта, как правило, не уменьшают.
Если необходимо пояснить отдельные данные или данные, относящиеся к началу крупного текстового фрагмента, то их следует помечать надстрочным знаком сноски, используя арабские цифры или знаки «*», причём применение более четырех «*» не допускается. Текст сноски располагают в конце страницы и отделяют от основного текста страницы короткой тонкой горизонтальной линией с левой стороны.
Как правило, текстовый редактор предоставляет средства для поддержки формирования сносок и работы с ними.
Ссылки в пояснительной записке могут быть как внешними (относиться к использованным источниками), так и внутренними (ссылаться на части текста самой записки).
Внешняя ссылка представляет собой номер источника по списку использованных источников, заключаемый в квадратные скобки. Можно ссылаться сразу на несколько источников. При необходимости, ссылка может быть указана с точностью до страницы в источнике. Например, при ссылке на один источник используется запись вида [21] или [21, с. 10], на несколько – [21, 30, 33-35].
Использование номера источника без квадратных скобок не допускается.
Ссылка указывает, что излагаемые положения, факты, рассуждения не принадлежат автору дипломного проекта, а заимствованы им. С другой стороны, применение ссылок придаёт материалу больший вес и убедительность. Использование заимствованного материала без ссылки на источник недопустимо.
Цитата, включаемая в текст записки, выделяется кавычками и снабжается ссылкой на источник. Если цитата полностью воспроизводит одно или несколько предложений цитируемого текста, то она начинается с прописной буквы. Если же она органически входит в состав авторского предложения, то начинается со строчной буквы, даже если в источнике использовалась прописная. При цитировании допускается делать пропуски, обозначая их многоточием, если смысл цитаты не искажается. При ссылке, кроме номера источника, обязательно указывается страница, с которой взята цитата.
При ссылках на составные части и элементы пояснительной записки указывают их номера. Например: «как описано в разд. 1», «см. п. 2.1.5», «как показано на рис. 3.1», «(рис. 3.1)», «в табл. 6.2», «подробнее – см. приложение Е».
Ссылки на номер формулы дают в круглых скобках, к примеру, «в формуле (6.1)».
Первую ссылку обычно делают по типу (на примере таблицы) «приведены в табл. 6.2» или «(табл. 6.2)». Повторные ссылки дают с сокращённым словом «смотри», например, «см. табл. 6.2». При значительной удалённости такой ссылки целесообразно также указывать номер листа, к примеру, «см. табл. 6.1, с. 57».