4.1.1 Пояснительная записка к проекту (работе) – это документ, в котором отражены все вопросы, связанные с разработкой и обоснованием принятых при проектировании технических и технико-экономических решений.
Требования к построению и выполнению текстовых документов, в частности, пояснительных записок, изложены в ГОСТ 2.105-95, ГОСТ 2.106-79 ЕСКД. В связи с тем, что ЕСКД разработана согласно требованиям промышленности и не учитывает особенности учебного процесса, в данных методических указаниях отражены допускаемые отклонения от некоторых стандартов и приведены требования к выполнению пояснительной записки к курсовым и дипломным проектам (работам).
4.1.2 Рубрикации разделов и последовательность их расположения в пояснительной записке приводится в соответствии с п. 2.1 и 2.2.1.
4.1.3 Титульный лист оформляется в соответствии с Приложением В данных методических указаний.
4.1.4 Техническое задание на проектирование оформляется согласно заданию на дипломный (курсовой) проект (работу) в соответствии с ГОСТ 15.001-88 и Приложением А данных методических указаний.
4.1.5 Реферат начинается с заголовка «РЕФЕРАТ». Текст реферата печатается через три межстрочных интервала после заголовка, приводятся сведения об объеме проекта, количестве иллюстраций, таблиц, перечень ключевых слов (слово или словосочетание, выражающее отдельное понятие, существенное для раскрытия содержания текста). Затем следует основной текст реферата. Перечень ключевых слов включает от 5 до 15 слов, написанных в строку, через запятые, в именительном падеже. Объем текста реферата определяется объемом проекта (работы) и не должен превышать 150 слов.
4.1.6 Раздел «Содержание» оформляется в виде двух колонок. В первой колонке последовательно перечисляют заголовки разделов, подразделов и приложений. Каждый раздел, подраздел указывают с новой строки, начинающейся с порядкового номера. Во второй колонке против последней строки соответствующего раздела или подраздела указывают номер страницы, на которой он помещен.
4.1.7 Пояснительную записку выполняют одним из следующих способов:
- машинописным, при этом следует выполнять требования ГОСТ 13.1.002. Шрифт пишущей машинки должен быть четким, высотой не менее 2,5 мм; лента только черного цвета (полужирная);
- рукописным – чертежным шрифтом по ГОСТ 2.304 с высотой букв и цифр не менее 2,5 мм. Цифры и буквы необходимо писать четко черной тушью;
- с применением печатающих и графических устройств вывода ЭВМ (ГОСТ 2.004).
4.1.8 По четырем сторонам листа формата А4 должны быть оставлены поля. Размер левого поля листа – 30 мм, правого – 10 мм, верхнего 20 мм, нижнего – 20 мм. В случае выполнения пояснительной записки на двух сторонах листа, на оборотной стороне листа расстояние выдержать в пределах: от левой кромки – 10 мм, от правой кромки – 30 мм.
4.1.9 В содержание пояснительной записки входят разделы, подразделы, пункты и подпункты. Каждый из разделов следует начинать с новой страницы. Слова, выполненные на отдельной строке («Содержание», «Введение», «Заключение», «Литература»), служащие заголовками соответствующих разделов, не должны нумероваться.
Нумерация разделов начинается с обзора литературы и выполняется арабскими цифрами. Например:
1 ОБЗОР СОВРЕМЕННОГО СОСТОЯНИЯ…
4.1.10 Подразделы начинаются с красной строки и нумеруются арабскими цифрами в пределах каждого раздела. Номер подраздела должен состоять из номера раздела и номера подраздела, разделенных точкой, например: «2.1.3» (пункт третий подраздела первого раздела второго).
4.1.11 Разделы, отражающие содержание и результаты проектирования, должны иметь содержательные заголовки. Их пишут прописными буквами, а заголовки подразделов – строчными (кроме первой прописной). Если заголовок состоит из двух и более предложений, их разделяют точкой. В конце заголовка точку не ставят. Подчеркивать и переносить слова в заголовках не допускается.
4.1.12 Номер соответствующего раздела или подраздела ставят в начале заголовка, номер пункта – в начале первой строки нового абзаца. Цифра, указывающая номер пункта, не должна выступать за границу абзаца. Расстояние между заголовками и последующим текстом не менее 10 мм. Расстояние между текстом и последующим заголовком не менее 15 мм.
4.1.13 Пояснительная записка должна быть сброшюрована. Допускается переплетать. Основная часть пояснительной записки в дипломном проекте (работе) должна составлять не менее 75 % от общего объема пояснительной записки.
Рекомендуется следующее примерное распределение объема пояснительной записки в страницах:
№ п/п | Разделы | Курсовой проект (работа) | Дипломный проект (работа) |
1. | Введение | 1-3 | 2-3 |
2. | Обзор литературы | 3-7 | 12-15 |
3. | Выбор направления проектирования | 3-4 | 5-8 |
4. | Выбор и расчет структурной схемы | 3-5 | 5-8 |
5. | Электрические расчеты узлов изделия | 3-5 | 7-12 |
6. | Анализ характеристик | 3-7 | 5-12 |
7. | Конструкторские и технологические расчеты | 1-2 | 3-5 |
8. | Методика изготовления изделия | - | 3-5 |
9. | Инструкции | - | 3-8 |
10. | Результаты экспериментов | - | 5-8 |
11. | Расчет показателей надежности | - | 6-7 |
12. | Технико-экономические расчеты | - | 10-12 |
13. | Охрана труда | - | 3-5 |
14. | Заключение | 1-2 | |
15. | Литература | 2-5 | |
16. | Приложение | 3-5 | 3-6 |
4.1.14 Нумерация страниц пояснительной записки должна быть сквозной: первая страница – титульный лист, вторая – задание на курсовой или дипломный проект и т.д. Номер страницы проставляют внизу в середине арабскими цифрами. На титульном листе в техническом задании номер страницы не ставят.
4.1.15 Рисунки, графика, таблицы, расположенные на отдельных листах, необходимо включать в общую нумерацию. Если рисунок или таблица расположены на листе формата больше А4, их следует считать одной страницей. Номер страницы в этих случаях можно не проставлять.
Оформление иллюстраций
4.2.1 Все иллюстрации (фотографии, схемы, чертежи и др.) называют рисунками.
4.2.2 Количество иллюстраций должно быть достаточным для пояснения излагаемого текста. Иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его. Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД и СПДС. Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается «Рисунок 1».
4.2.3 Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: Рисунок А.3.
Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например: Рисунок 1.1.
При ссылках на иллюстрации следует писать «… в соответствии с рисунком 2» при сквозной нумерации и «… в соответствии с рисунком 1.2» при нумерации в пределах раздела.
Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом:
Рисунок 1 – Детали прибора.
4.2.4 Если в тексте документа имеется иллюстрация, на которой изображены составные части изделия, то на этой иллюстрации должны быть указаны номера позиций этих составных частей в пределах данной иллюстрации, которые располагают в возрастающем порядке, за исключением повторяющихся позиций, а для электро- и радиоэлементов – позиционные обозначения, установленные в схемах данного изделия.
Исключение составляют электро- и радиоэлементы, являющиеся органами регулировки или настройки, для которых (кроме номера позиции) дополнительно указывают в подрисуночном тексте назначение каждой регулировки и настройки, позиционное обозначение и надписи на соответствующей планке или панели.
Допускается, при необходимости, номер, присвоенный составной части изделия на иллюстрации, сохранять в пределах документа.
4.2.5 Сокращение слов без пояснений в тексте и подписях под рисунками не допускаются. Исключение составляют сокращения, установленные ГОСТ 2.316-68.
4.2.6 Иллюстрации, на которых изображаются графики, выполняются различно, в зависимости от того, отображают ли они качественный характер или же количественное соотношение между аргументом и функцией. Примеры оформления соответствующих графиков приведены в Приложении Г.
4.2.7 Оформление координатных осей сеток и характерных точек, выбор масштаба шкал, обозначение величин, нанесение единиц измерения и поясняющих надписей на диаграммах и графиках производить по ГОСТ 1.5-85 и Р 50-77-88 (см. Приложение Г).
Построение таблиц
4.3.1 Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Название таблицы должно отражать ее содержание, быть точным, кратким. Название следует помещать над таблицей.
При переносе части таблицы на ту же или другие страницы название помещают только над первой частью таблицы.
Цифровой материал, как правило, оформляют в виде таблиц.
Таблица ____ – _________________________
номер название таблицы
Головка | Заголовки граф | |||||
Подзаголовки граф | ||||||
Строки (горизонтальные ряды) | ||||||
Боковик (графа для заголовков) | Графы (колонки) |
4.3.2 Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена «Таблица 1» или «Таблица В.1», если она приведена в приложении В.
Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой.
4.3.3 На все таблицы документа должны быть приведены ссылки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера.
4.3.4 Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.
4.3.5 Таблицы слева, справа и снизу, как правило, ограничивают линиями.
Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
Головка таблицы должна быть отделена линией от остальной части таблицы.
Высота строк таблицы должна быть не менее 8 мм.
4.3.6 Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости, в приложении к документу.
Допускается помещать таблицу вдоль длинной стороны листа документа.
4.3.7 Если строки или графы таблицы выходят за формат страницы, ее делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют ее головку и боковик. При делении таблицы на части допускается ее головку или боковик заменять соответственно номером граф и строк. При этом нумеруют арабскими цифрами графы и (или) строки первой части таблицы.
Слово «таблица» указывают один раз слева над первой частью таблицы, над другими частями пишут слова «Продолжение таблицы» с указанием номера (обозначения) таблицы.
Написание формул
4.4.1 При выполнении расчетов используют инженерную форму записи по схеме (расчетная формула – числовая подстановка – результат вычислений с указанием размерности).
Формулы нумеруют в пределах раздела арабскими цифрами. Номер должен состоять из номера раздела и порядкового номера формулы, разделенной точкой, например: «(1.2)» - (формула вторая раздела первого). Его следует заключать в скобки и помещать в правом поле на уровне нижней строки формулы, к которой он относится, причем правая скобка, заключающая номер формулы, должна находиться на границе текста. При ссылке в тексте на формулу необходимо писать, например: «В формуле (1.2)…»
4.4.2 В экспликации (расшифровке) значения символов и числовых коэффициентов должны приводиться непосредственно под формулой. Значение каждого символа и числового коэффициента рекомендуется давать с новой строки. Первую строку экспликации начинают со слова «где» без абзацного отступа, двоеточия после него не ставят.
Например:
«… емкость плоского конденсатора в фарадах находится на формуле
,
где – относительная диэлектрическая проницаемость;
=8,85·10 – диэлектрическая постоянная, Ф/м;
S – площадь электродов конденсатора, м ;
d – расстояние между электродами, м».
Несложные однострочные формулы можно помещать внутри текста.
Ссылка на литературу
При ссылке в тексте на источники документальной информации следует приводить порядковый номер по списку литературы, заключая его в квадратные скобки. Например: «В [1] приводятся …». В список литературы заносят все употребляемые в процессе работы над проектом (работой) источники.
Список литературы в процессе работы над проектом (работой) должен иметь заголовок «Литература». Список оформляется в соответствии с ГОСТ 7.1-84. Каждый источник информации указывается с новой строки, начинающейся с порядкового номера источника с точкой после номера. Нумерация источников должна проводиться по порядку их упоминания в тексте записки. Примеры записей библиографических данных в списке литературы приведены ниже.
1 Хвощ С.Т. и др. Микропроцессоры и микро-ЭВМ в системах автоматического управления: Справ. – Л.: Машиностроение, 1987. – 640 с.
2 Пат. 2073482 РФ, 6А61 5/02. Способ измерения артериального давления / А.П. Попов, В.И. Степанов (Россия). – Опубл. 20.02.97.
3 Степанов В.И. Интегральная широтно-импульсная модуляция в статических системах автоматического регулирования // Известия ВУЗов – Приборостроение. – 1981. - № 1. – С. 35-40.
4 Степанов В.И. Патентоведение: Учеб. пособие. – Омск: ОмГТУ, 2000. – 68 с.
5 Тихонов А.И., Степанов В.И. Принцип работы и анализ электронного счетчика электрической энергии / ОмГТУ. – Омск, 2001. – 51 с. – Деп. в ВИНИТИ 12.11.2001. № 2341-В2001.
6 Степанов В.И. Устойчивость в большом системы стабилизации с широтно-импульсной модуляцией второго рода (ШИМ-2) // Сб. науч. тр. НГТУ – Новосибирск, 1996. - № 2. – С. 59-63.
7 ГОСТ Р15.011-96. Патентные исследования. Содержание и порядок проведения. Система разработки и постановки продукции на производство. – М.: Изд-во стандартов, 1996.
Оформление приложений
4.6.1 Материал, дополняющий текст документа, допускается помещать в приложениях. Приложениями могут быть, например, графический материал, таблицы большого формата, расчеты, описания аппаратуры и приборов, описания алгоритмов и программ задач, решаемых на ЭВМ и т.д.
Приложение оформляют как продолжение документа на последующих его листах или выпускают в виде самостоятельного документа.
4.6.2 Приложения могут быть обязательными и информационными.
Информационные приложения могут быть рекомендуемого или справочного характера.
4.6.3 В тексте документа на все приложения должны быть даны ссылки. Степень обязательности приложений при ссылках не указывается. Приложения располагают в порядке ссылок на них в тексте документа.
4.6.4 Каждое приложение следует начинать с новой страницы с указанием наверху посередине слова «Приложение» и его обозначения, а под ним в скобках для обязательного приложения пишут слово «обязательное», а для информационного – «рекомендуемое» или «справочное».
4.6.5 Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность.
Допускается обозначение приложений буквами латинского алфавита за исключением букв I и O.
В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами.
Если в документе одно приложение, оно обозначается «Приложение А».
4.6.6 Приложения, как правило, выполняют на листах формата А4. Допускается оформлять приложения на листах формата А3, А4×3, А4×4, А2 и А1 по ГОСТ 2.301.
4.6.7 Текст каждого приложения, при необходимости, может быть разделен на разделы, подразделы, пункты, подпункты, которые нумеруют в пределах каждого приложения. Перед номером ставится обозначение этого приложения.
Приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц.
4.6.8 Все приложения должны быть перечислены в содержании документа (при наличии) с указанием их номеров и заголовков.
4.6.9 В тексте документа за исключением формул, таблиц и рисунков, не допускается:
- применять математический знак минус (–) перед отрицательными значениями величин (следует писать слово «минус»);
- применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте документа, перед размерным числом следует писать знак «Ø»;
- применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), ≥ (больше или равно), ≤ (меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент);
- применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе;
- сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц, и в расшифровках буквенных обозначений, входящих в формулы и рисунки.