Требования к оформлению пояснительной записки

 

Пояснительная записка должна быть оформлена в соответствии с требованиями ЕСКД к выполнению текстовых документов (ГОСТ 2.105-79).

Общие требования к пояснительной записке:

четкость построения;

логическая последовательность и грамотность;

убедительность аргументации;

краткость и четкость формулировок,;

доказательность выводов и обоснованность рекомендаций.

Пояснительная записка должна включать в себя:

- титульный лист (Приложение 2);

- задание на дипломное проектирование (Приложение 3);

- аннотацию;

- оглавление;

- введение;

- основные расчетные материалы проекта (работы) с иллюстрациями(см. п.п. 3.1, 3.2.)

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

- список литературы;

- приложения;

Титульный лист и задание дипломного проекта оформляются на бланках в соответствии с приложениями 2 и 3.

Аннотация - сокращенное изложение содержания выполненного проек­та и должна содержать:

- сведения об объеме проекта, количестве иллюстраций, таблиц, приложений и количестве использованных источни­ков;

- в тексте должно быть раскрыто основное содержа­ние проекта и практические предло­жения автора.

Объем аннотации - 5...6 строк.

Оглавление должно содержать названия разделов и подразделов с указанием номеров страниц. Располагать оглавление предпочтительно после аннотации.

Слово "Оглавление" записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в оглавление, записы­вают строчными буквами, начиная с прописной буквы или в соответствии со стилем заголовков разделов и подразделов.

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

Пояснительная записка дипломного проекта содержит текстовую часть и поясняющие рисунки, выполняется на одной стороне листа формата А4 без ограничительных рамок и основных надписей. Поля должны оставаться по всем четырем сторонам листа. Размер левого 20…30 мм, правого - 20...10 мм, верхнего и нижнего полей - 20 мм. Стиль шрифта – Times New Roman, размер шрифта – 14, расстояние между строками 1,5 интервала. Тексты распечаток программ расчетов и других приложений могут быть напечатаны более мелким шрифтом.

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

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

Разделы (главы) нумеруются арабскими цифрами. После номера раздела (главы) точка не ставится, введению номер не присваивается. Текст разделов (глав) пояснительной записки делится на подразделы, пункты и подпункты, причем слова "Раздел", "Глава" не пишутся.

Подразделы имеют двойную нумерацию в пределах каждого раздела (главы). В конце номера подраздела точка не ставится, например: 2.3 (третий подраздел второго раздела). Разделы, как и подразделы, могут состоять из одного или нескольких пунктов. Нумерация пунктов уже тройная в пределах подраздела, и номер пункта должен со­стоять из номеров раздела, подраздела и пункта, разделенных точками, на­пример: 2.3.3 (третий пункт третьего подраздела второго раздела). Если раздел или подраздел состоит из одного пункта, он также нумеруется.

Каждый пункт и подпункт записывают с абзацного отступа.

Разделы и подразделы должны иметь заголовки. Пункты, как прави­ло, заголовков не имеют. Заголовки должны четко и кратко отражать со­держание разделов, подразделов. Заголовки разделов (глав) печа­таются прописными буквами: заголовки подразделов - строчными (кроме первой прописной). Если заголовок состоит из двух и более предложений, их разделяют точкой. В конце заголовка точку не ставят. Подчеркивать за­головки не допускается.

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

Расстояние между заголовком и текстом должно быть равно 3 строкам (расстояние между строками 1 интервал). Расстояние между заголовками раз­дела и подраздела – 2 строки. Для подразделов, текст которых записывают на одном листе с текстом предыдущего подраздела, между последней строкой текста и последующим заголовком - 2 строки.

Каждый раздел рекомендуется начинать с новой страницы, применение чистого листа только с заголовком разде­ла (главы) не допускается.

Нумерация страниц и приложений пояснительной записки должна быть сквозной; пер­вая страница (титульный лист) не проставляется, вторая страница – задание на проект. Номер страницы проставляют арабскими цифрами в правом верхнем углу без точки. Если рисунок или таблица расположены на листе формата A3, их следует учитывать как одну страницу.

Список литературы включается в сквозную нумерацию.

 

Написание формул

 

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

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

Y = k [а (b + сх)].

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

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

Знак умножения следует применять между числовыми сомножителями (25 • 653,7) или когда вслед за аргументом тригонометрической функции стоит буквенное обозначение, а также для отделения сомножителей от вы­ражений, относящихся к знакам логарифма, интеграла, радикала и т.п., на­пример:

Если формула не умещается в одной строке, то ее частично переносят на другую строку. В первую очередь перенос следует делать на знаках ра­венства и соотношения между левой и правой частями формулы (=, ~, >, < и т.д.), во вторую - на знаках сложения и вычитания (+, -), в третью - на знаке умножения применением косого креста (х) в конце одной строки и начале следующей строки. Не допускаются переносы на знаке деления.

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

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

Расшифровку значений символов располагают в виде колонки, символ отделяют от его расшифровки знаком тире. Размерность буквенного обозна­чения отделяют от текста запятой. Затем пишут численное значение симво­ла и при необходимости делают ссылку на источник. Пос­ле расшифровки каждого символа ставят точку с запятой. Колонки вырав­нивают по тире.

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

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

Формулы должны нумероваться сквозной нумерацией арабскими цифрами, которые записывают на уровне формулы справа в круглых скобках. Первую формулу обозначают - (1). Ссылки в тексте на порядковые номера формул дают в скобках, напри­мер:... в формуле (3).

Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разде­ленных точкой, например (2.1).

При указании величин с двумя пределами “от” и ”до” между ними ставят тире, многоточие или предлоги “от” и ”до”, а обозначение размерности ставят только один раз после второй цифры, например: 6…9 мм, в пределах от 5 до 10 град.

Если предельные числа представляют собой порядковые номера, то ин­тервалы чисел в тексте записывают только через дефис, например: рис.3-6.

Рядом стоящие цифровые величины отделяют одну от другой точкой с запятой, например: линейные размеры изменяются соответственно на 0.5; 1; 1,5; 5 мм.

 

Терминология

 

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

Условные буквенные обозначения механических, химических, мате­матических и других величин, а также условные графические обозначения должны соответствовать установленным стандартам. В тексте перед обозначением параметра дают его пояснение, например: давление Р, Мпа_.

В пояснительной записке не допускается:

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

- применять индексы стандартов и технических условий без регистраци­онного номера (ГОСТ, РСТ, СТП, ТУ);

 

Оформление иллюстраций

 

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

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

Не допускается применение рисунков, схем, чертежей, выре­занных из книг, журналов, отчетов и т.д.

Ил­люстрации должны быть выполнены в соответствии с требованиями стан­дартов ЕСКД и обычно располагаются на следующей странице после упоминания тексте документа.

Иллюстрации, за исключением иллюстраций прило­жений, следует нумеровать арабскими цифрами сквозной нумерацией, точка после цифры не ставится: Рису­нок 3. Допускается нумеровать иллюстрации в пределах раздела. В этом слу­чае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой: Рисунок 1.1. Выравнивание по левому краю страницы.

При ссылках на иллюстрации следует писать "см. рис. 3".

Иллюстрации кроме номера должны иметь наименование и поясни­тельные данные (подрисуночный текст). Например, Рисунок 1.2 – Тепловая схема ПТУ.

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

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

Графики (диаграммы) - наиболее простой, удобный и наглядный способ передачи содержания информации, он может заменить длинные объяснения, сложный чертеж или таблицу.

Оси координат - оси абсцисс и орди­нат - вычерчивают сплошными линиями толщи­ной около 0.3 мм. Толщину линий сетки следует выдерживать примерно равной половине тол­щины линий осей координат.

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

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

Величину графического интервала (расстояние между делительны­ми штрихами или линиями координатной сетки) следует выбирать с учетом удобства отсчета.

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

Многозначные числа предпочтительно выражать как кратные 10ⁿ, где n – целое число. Коэффициент 10ⁿ следует указывать для данного диапазона шкалы.

В диаграмме со шкалами обозначения величин следует размещать у середины шкалы с ее внешней стороны, а при объединении символа с обозначением единицы измерения в виде дроби - в конце шкалы после по­следнего числа.

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

Единицы измерения обычно наносятся вместе с наименованием переменной величины после запятой или в конце шкалы после последнего числа вместе с обозначением перемен­ной величины в виде дроби, в числителе которой наносят обозначение еди­ницы измерения.

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

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

Многоцветные иллюстрации допускаются в основном для сложных рисунков, когда для выделения отдельных элементов иллю­страций обойтись одним цветом затруднительно.

Цветные линии должны быть ровными и одинаковыми по толщине. Ко­личество красок на иллюстрации должно быть минимальным - не более пя­ти, включая черную. Даже для наиболее сложных схем каждый цвет надо использовать для изображения нескольких элементов.

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

 

Построение таблиц

 

Цифровой материал, как правило, оформляют в виде таблиц.

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

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

Таблицы, цифровые данные которых не укладываются на один лист, располагаются на развернутом листе (формат A3). Таблицы слева, справа, сверху и снизу, как правило, ограничивают линиями.

Таблицы следует нумеровать арабскими цифрами сквозной нуме­рацией. Допускается нумеровать таблицы в пределах раздела. В этом случае но­мер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой. Символ "№" при этом не пишется. На все таблицы документа должны быть приведены ссылки в тексте документа.

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

Головка таблицы должна быть отделена линией от остальной части таблицы. Высота строк таблицы должна быть не менее 8 мм.

Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости, в приложении к документу. Слово "Таблица" указывают один раз слева над первой частью таблицы, над другими частями пишут слова "Продолжение таблицы" с указанием номера таблицы.

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

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

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

Сокращения

 

Перечень допускаемых сокращений слов установлен ГОСТ 2.316. Если в документе принята особая система сокращения слов или наименова­ний, то в нем должен быть приведен перечень принятых сокращений.

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

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

Не допускается сокращать один и тот же термин по-разному или пи­сать его в одном месте полностью, а в другом сокращенно.

Сокращенные названия учреждений, предприятий, марки изделий, машин, аппаратов и материалов, состоящие из начальных букв слов, входя­щих в название, пишут прописными буквами без точек и кавычек. Напри­мер: НИИ - научно - исследовательский институт

Из сокращенных названий учреждений и предприятий следует употреб­лять только общеизвестные. Малоизвестные сокращения надо обязательно расшифровывать при первом упоминании.

Слово год после дат сокращают, оставляя одну букву с точкой “г”, после нескольких дат (во множественном числе) ставят две буквы "гг." (точку между ними не ставят).

Тысячи, миллионы и миллиарды при цифрах сокращаются как "тыс.", "млн.", "млрд.".

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

В задании на проектирование указываются:

- основные размерения судна;

- скорость хода;

- параметры энергетической установки.

 

Оформление приложений

 

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

В приложениях помещаются:

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

- описа­ние аппаратуры и приборов, применяемых при работе:

- иллюстрации вспомо­гательного характера (схемы, графики, диаграммы, рисунки, эскизы, чертежи, фотографии);

- описания алгоритмов и программ задач, решаемых на ЭВМ, и т.д..

Каждое приложение следует начинать с новой страницы суказа­нием наверху страницы слова "Приложение" и его обозначения, выровненного по правому краю страницы. Приложения обычно обозначают цифрами, но можно и буквами, например: Приложение 1, Приложение А и т.д.

Приложение должно иметь заголовок, который записывают с про­писной буквы отдельной строкой.

В тексте на все приложения должны быть даны ссылки, на­пример: (см. Приложение 1). Приложения располагают в порядке ссылок на них в тексте.

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

Иллюстрации каждого приложения обозначают отдельной нумера­цией арабскими цифрами с добавлением перед цифрой обозначения прило­жения, например: Рисунок 11.2.

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