Оформление пояснительной записки
Общие требования
Устанавливается следующая структура обозначения документов ВКР:
СамГТУ ХХХХХХ ХХХ-ХХ ХХХХ ХХ
Например, для темы, зарегистрированной под номером 1453 на кафедре 152-67 (код кафедры «ИСУ») по направлению 230100, обозначения будут следующие:
СамГТУ.230100.152-67.1453.01ТЗ – техническое задание
СамГТУ.230100.152-67.1453.02ПЗ – пояснительная записка
СамГТУ.230100.152-67.1453.03 – первый лист графического материала проекта
СамГТУ.230100.152-67.1453.04 – второй лист графического материала проекта
СамГТУ.230100.152-67.1453.05 – третий лист графического материала проекта и т.д.
Пояснительная записка должна быть набрана на компьютере и отпечатана на принтере с использованием современных текстовых и, если необходимо, графических редакторов на листах белой бумаги формата А4 без рамки, основной надписи и дополнительных граф. Повреждение листов, помарки текста или рисунков не допускаются. Пояснительная записка должна быть сброшюрована типографским способом в твердый переплет.
Текст располагают с одной стороны листа, высота букв и цифр должна быть не менее 2,5 мм. Рекомендуемый шрифт основного текста Times New Roman размером 14 пт, цвет шрифта – черный, рисунки допускаются цветные. Приложения, содержащие листинг программы, допускается печатать шрифтом размером 10 пт.
Размеры полей: левое – 30 мм, правое – 15 мм, верхнее и нижнее – 20 мм. Расстояние между строками (базовое) – полтора интервала. При печати необходимо соблюдать равномерную плотность текста.
Абзацы в тексте начинают отступом от края левого поля, равным 15 мм. Цифры, указывающие номера разделов и подразделов, также проставляют с отступом.
Нумерация страниц документа, включая приложения, должна быть сквозная по всему тексту (первый лист – титульный). Номера страниц проставляются в правом верхнем углу без точки в конце. На титульном листе, реферате и на содержании номера страниц не ставятся.
Слово «Реферат» на странице с рефератом не пишется, в содержание не включается.
Допускается вписывать от руки в текст записки отдельные слова, условные обозначения и формулы, используя черные чернила, тушь, шариковую, глеевую ручку или фломастер. При этом плотность (т.е. чернота), толщина линий, и размеры символов вписанного текста не должны значительно отличаться от соответствующих параметров печатного текста.
Если размеры таблицы или иллюстрации требуют расположения вдоль страницы, то лист подшивают в документ так, чтобы при чтении его надо было повернуть по часовой стрелке.
Структурными элементами основной части документа являются разделы, подразделы, пункты и перечисления. Разделы должны иметь порядковые номера в пределах всего документа, обозначенные арабскими цифрами без точки. Подразделы должны иметь нумерацию в пределах каждого раздела. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой. Разделы, как и подразделы, могут состоять из одного или нескольких пунктов. Номер пункта должен состоять из номеров раздела, подраздела и пункта, разделенных точками. После последней цифры номера подраздела, пункта точка не ставится, например: 4.2, 4.2.1. Трехзначная нумерация является предельной.
Внутри пунктов могут быть приведены перечисления. Перед каждой позицией перечисления следует ставить тире. Такое оформление перечислений наиболее удобно, поскольку позволяет избежать ограничений, возникающих при использовании нумерации. При необходимости ссылки на перечисления для их обозначения используют строчные буквы со скобкой. Для дальнейшей детализации перечислений необходимо использовать арабские цифры со скобкой, а запись производится с абзацного отступа. Заканчивать каждую позицию перечисления следует соответствующим знаком препинания как показано в примере.
Пример
а) текст;
б) текст:
1) текст;
2) текст.
в) текст.
Разделы, подразделы, пункты должны иметь заголовки.
Заголовки разделов (сюда же относятся «Введение», «Перечень сокращений», «Заключение») следует печатать с абзацного отступа строчными буквами (первая – прописная) без точки в конце, не подчеркивая. Заголовки разделов выполняются шрифтом Times New Roman размером 16 пт, подразделов, пунктов и подпунктов – 14 пт. Использование полужирного начертания допускается. Выравнивание заголовков производится по левому краю.
Переносы слов в заголовках не допускаются. Если заголовок состоит из двух предложений, их разделяют точкой. Точку в конце заголовков не ставят.
Слова «Раздел», «Глава», «Параграф» указывать не следует ни в содержании, ни в заголовках основной части. Допускается все заголовки печатать полужирным (bold) шрифтом.
Если заголовок раздела или подраздела размещается на нескольких строках, то последующая строка также печатается с абзацного отступа (в параметрах абзаца указать отступ слева 15 мм). Например:
Описание технологического процесса и объекта управления. Постановка задачи проектирования
Расстояние между заголовками и текстом должно быть приблизительно равно 15 мм (две пустые строки, т.е. два нажатия клавиши Enter, с одинарным интервалом, 14 пт).
Расстояние между заголовками раздела и подраздела – 8 мм (одна пустая строка, то есть одно нажатие клавиши Enter, с одинарным интервалом, 14 пт).
Каждый раздел пояснительной записки следует начинать с новой страницы..
Не допускается размещать текст между заголовками раздела и подраздела.
Полное наименование объекта проектирования на титульном листе и при первом упоминании в тексте должно быть одинаковым. В последующем тексте порядок слов в наименовании должен быть прямой, т.е. на первом месте должно быть определение (имя прилагательное), а затем – наименование объекта (имя существительное); при этом допускается употреблять сокращенное наименование объекта.
Не допускаются пробелы между строками основного текста.
Оформление формул
В формулах в качестве символов следует применять обозначения, установленные соответствующими государственными стандартами. Пояснение символов и числовых коэффициентов, входящих в формулу, если они не пояснены ранее в тексте, должны быть приведены непосредственно под этой формулой.
Пояснения каждого символа следует давать с новой строки в той последовательности, в которой символы приведены в формуле. Первая строка пояснения должна начинаться со слова «где», без двоеточия после него.
Пример
Плотность каждого образца r, пт/м3, вычисляют по формуле
, (1)
где, r – плотность образца, пт/м3;
m – масса образца, пт;
V – объём образца, м3.
При написании формул следует применять следующие знаки препинания: двоеточие – перед перечислением формул, точка с запятой – между формулами, запятая – перед словом «где», точка – если формула заканчивает главное предложение.
Переносить формулы на следующую строку допускается только на знаках выполняемых операций, причем знак в начале следующей строки повторяют. При переносе формулы на знаке умножения применяют знак «×». Высота цифр должна быть не менее 2,5 мм.
Формулы в тексте документа, за исключением формул, помещаемых в приложении, должны нумероваться сквозной нумерацией арабскими цифрами, которые записывают на уровне формулы справа в круглых скобках. Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например (3.1) – первая формула третьего раздела.
Ссылки на порядковые номера формул, если это необходимо, дают в круглых скобках, например,... в формуле (1).
Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед цифрами номера буквенного обозначения приложения, например, формула (В.1).
Между формулой и пояснениями к ней и основным текстом сверху и снизу оставляется пустая строка (с одинарным интервалом).
Оформление иллюстраций
Оформление иллюстраций пояснительной записки выполняется с помощью графических компьютерных программ – редакторов или с помощью чертежных инструментов по ГОСТ 7-32 и по ГОСТ 2.105. Количество рисунков в пояснительной записке должно быть достаточным для того, чтобы ее текст можно было читать с минимальным обращением к документам графической части проекта.
Все иллюстрации (графики, схемы, диаграммы, фотографии, экранные формы) именуются рисунками.
Иллюстрации располагают непосредственно после первого упоминания или на следующей странице. Иллюстрации следует обозначать словом «Рисунок» и следует нумеровать, за исключением иллюстраций приложений, арабскими цифрами сквозной нумерации. Допускается нумеровать иллюстрации в пределах раздела, например «Рисунок 2.1» (первый рисунок второго раздела). На все иллюстрации документа должны быть приведены ссылки в тексте документа, при ссылках на иллюстрации следует писать «… в соответствии с рисунком 2.1».
Допускается не нумеровать мелкие рисунки, размещенные непосредственно в тексте и на которые в дальнейшем нет ссылок.
Пример
Рисунок 2.1 – Защищенные сессии сервера
Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой номера буквенного обозначения приложения. Например: «Рисунок А.3».
Для схем алгоритмов и программ, располагаемых на нескольких листах пояснительной записки, на первом листе указывается «Рисунок…», на последующих листах – «Продолжение рисунка….».
Иллюстрации при необходимости могут иметь наименование и поясняющие данные (подрисуночный текст). Разделителем между обозначением «Рисунок 1» и наименованием рисунка служит «тире». Сам рисунок, пояснительные данные (если они нужны), номер рисунка с его наименованием (если оно есть) размещают последовательно сверху вниз (одно под другим).
Номер рисунка и название выполняются шрифтом Times New Roman размером 12 пт, все пояснительные надписи выполняются шрифтом Times New Roman размером 11 пт. Точку после наименования рисунка не ставят. Выравнивание рисунков и подрисуночных надписей осуществляется по центру страницы, без абзацного отступа. Ширина подрисуночной надписи должна соответствовать ширине рисунка.
Рисунок и его наименование отделяются от основного текста сверху и снизу пустой строкой (с одинарным интервалом).
Построение таблиц
Оформление таблиц пояснительной записки выполняется по ГОСТ 7-32 и ГОСТ 2.105.
Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким.
Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией в пределах документа. Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы в данном разделе, разделенных точкой, например: «Таблица 1.1» - первая таблица первого раздела.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрами номера буквенногообозначения приложения (разделенными точкой), например: «Таблица А.2».
Если в документе одна таблица, она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В.
Название таблицы, при его наличии, следует помещать над таблицей. Слово «Таблица» выравнивается по левой границе таблицы без абзацного отступа, далее ставится ее номер, затем тире и название таблицы. Название таблицы выравнивается по ширине таблицы.
При переносе части таблицы слово «Таблица» и её название указывают один раз над первой частью таблицы, над другими частями слева пишут слова «Продолжение таблицы» с указанием номера (обозначения) таблицы.
На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово “таблица” с указанием её номера. Таблицу в зависимости от ее размера помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости – в приложении. Допускается располагать таблицу по длине листа.
Таблица отделяется от основного текста пустыми строками (до названия таблицы и после таблицы).
Таблицы слева, справа и снизу, как правило, ограничивают линиями. Если в конце страницы таблица прерывается, то линию, ограничивающую таблицу снизу, не проводят. Высота строк таблицы должна быть не менее 8 мм.
Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе. Допускается выделять заголовки и подзаголовки таблиц полужирным шрифтом. При необходимости допускается перпендикулярное расположение заголовков граф.
Пример
Таблица 4.1 – Сводные характеристики физических архитектур сети
| Характеристика | Ethernet 10Base-T | Fast Ethernet 100Base-TX | Token Ring |
| Битовая скорость | 10 Мбит/с | 100 Мбит/с | 16 Мбит/с |
| Топология | Шина/звезда | Шина/звезда | Звезда/кольцо |
| Среда передачи данных | Витая пара | Витая пара | Витая пара |
Продолжение таблицы 4.1
| Максимальная длина сети (без мостов) | 2500 м | 200 м | 4000 м |
| Максимальное расстояние между узлами | 2500 м | 200 м | 100 м |
| Тактирование и восстановление после отказов | Не определены | Не определены | Активный монитор |
В одной графе должно быть соблюдено одинаковое количество десятичных знаков для всех значений величин. При отсутствии отдельных данных в таблице следует ставить прочерк (тире).
Название таблицы, заголовки граф и все надписи таблицы делаются шрифтом Times New Roman размером 12 пт.
Ссылки
В тексте документа в соответствующем месте должны быть помещены ссылки на каждую иллюстрацию, например, … в соответствии с рисунком 2…, и каждую таблицу, например, …как следует из таблицы 5….
Ссылки на литературные источники следует указывать порядковым номером по списку источников, взятым в квадратные скобки, например [3], [11, с.93].
Ссылаться следует на источники в целом или его разделы и приложения. Ссылки на подразделы, пункты, таблицы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц и иллюстраций данного документа.
Сноски в тексте обозначают надстрочными символами (арабской цифрой или звездочкой «*»), а текст сноски располагают с абзацного отступа в конце поля страницы, на которой сноски обозначены. Нумерация сносок на каждой странице – отдельная. Сноски отделяют от основного текста короткой горизонтальной линией с левой стороны.