Server\General\Титульные листы и формы\Шаблон пояснительной записки.doc.

1 Общие требования к текстовым документам

5.1 Оформление листов

5.1.1 Текстовые документы следует выполнять на бумаге формата А4 (210 ´ 297 мм) по ГОСТ 2.301 и ГОСТ 9327.

5.1.2 Пояснительные записки ВКР и КП (КР) выполняются на односторонних формах с рамкой и основной надписью по ГОСТ 2.104.

Формы основных надписей, используемые в текстовых документах студентов, приведены в СТП 4.02-2005.

Размеры текстовых полей документов, выполненных на формах, составляют: правое – 5 мм, левое – 20 мм, верхнее – 15 мм и нижнее – 50 мм (для первого листа) и 25 мм (для последующих листов);

5.1.3 Все остальные текстовые документы допускается выполнять на листах формата А4 с двух сторон с зеркальными полями: переплет 0 мм, внутри 25 мм, снаружи 15 мм, верхнее 15 мм, нижнее 15 мм.

5.1.4 Шаблон пояснительной записки располагается по адресу:

\\Server\General\Титульные листы и формы\Шаблон пояснительной записки.doc.

5.1.5 Шаблон текстового документа для методических работ преподавателей располагается по адресу:

\\Server\Forms\Бланки и шаблоны\Шаблон текстового документа.doc.

5.2 Способы выполнения текста

5.2.1 Текст следует выполнять с применением ЭВМ, соблюдением требований
ГОСТ 2.004 и настоящего стандарта;

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

5.2.3 Недопустимо различное оформление отдельных страниц документа; при необходимости особого оформления такие страницы следует помещать в приложения по 13.

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

- параметры шрифта: Times New Roman, 14 пт;

- параметры абзаца: отступы слева и справа 0,5 см (расстояние от рамки), отступ первой строки 1,5 см, междустрочный интервал - полуторный, выравнивание – по ширине;

- параметры маркированного списка: отступ от края текста до маркера – 2 см, табуляция после – 2,5 см, отступ положения текста – 0,5 см.

5.3 Нумерация страниц

5.3.1 Страницы следует нумеровать арабскими цифрами в правом (внешнем) нижнем углу листа внутри полей без точки и тире; расстояние от номера страницы до края листа и текста – не менее 5 мм.

При нумерации страниц, выполненных на формах, номер следует проставлять в специально отведенном поле основной надписи.

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

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

5.4 Общие требования к тексту

5.4.1 Структурные элементы по разделу 4 следует начинать с нового листа.

5.4.2 Сокращения слов в тексте недопустимы, за исключением обозначений единиц физических величин по ГОСТ 8.417.

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

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

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

При этом допускается использовать повествовательную форму изложения текста документа, например «применяют», «указывают» и т.п.

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

5.4.4 В тексте документа не допускается:

- применять обороты разговорной речи;

- применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;

- применять произвольные словообразования;

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

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

5.4.5 В тексте документа, за исключением формул, таблиц и рисунков, не допускается:

- применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово "минус");

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

- применять без числовых значений математические знаки, например > (больше),
< (меньше), = (равно), ≥ (больше или равно), ≤ (меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент).

5.4.6 Если в документе приводятся поясняющие надписи, наносимые непосредственно на изготовляемое изделие (например на планки, таблички к элементам управления и т.п.), их выделяют шрифтом (без кавычек), например ВКЛ., ОТКЛ., или кавычками - если надпись состоит из цифр и (или) знаков.

Наименования команд, режимов, сигналов и т.п. в тексте следует выделять кавычками, например, "Сигнал +27 включено".

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

5.4.8 В документе следует применять стандартизованные единицы физических величин, их наименования и обозначения в соответствии с ГОСТ 8.417.

Наряду с единицами СИ, при необходимости, в скобках указывают единицы ранее применявшихся систем, разрешенных к применению. Применение в одном документе разных систем обозначения физических величин не допускается.

5.4.9 Ряд числовых значений или значения с предельными отклонениями необходимо указывать в соответствии с примером:

Например:

от 0,03 до 0,30 мм; 10 ´ 10 ´ 50 м;

8,0; 8,5; 9,0 мм; (100 ± 0,1) кг; 50 г ± 1 г.

2 Основная часть

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

6.1 Оформление текста

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

6.1.2 Номер раздела следует указывать перед его наименованием. Номер подраздела (пункта, подпункта) должен состоять из номеров раздела, подраздела (пункта и подпункта), разделяемых точками. В конце номера точку ставить недопустимо. Например: 5 – номер пятого раздела; 3.2 – номер второго подраздела третьего раздела; 2.3.1.4 – номер четвертого подпункта первого пункта третьего подраздела второго раздела.

Номер раздела (подраздела) отделяется от наименования пробелом.

6.1.3 Если внутри пункта или подпункта необходимы перечисления, то они реализуются маркированными списками (в качестве маркера используется дефис) в соответствии с 5.2.4-5.2.5; при необходимости последующих ссылок вместо дефиса указывают строчную букву со скобкой, а при дальнейшей детализации – арабскую цифру со скобкой.

6.1.4 Разделы и подразделы должны иметь заголовки. Заголовки остальных составных частей не обязательны.

6.1.5 Недопустимы подчеркивание заголовков, перенос слов и точка в конце заголовка.

6.1.6 Для заголовков разделов в работах студентов (стиль «_Заголовок») предусматриваются следующие параметры шрифта:

- Times New Roman, размером 16 пт;

- полужирное начертание;

- все буквы прописные.

и следующие параметры абзаца:

- выравнивание по левому краю;

- отступ слева в размере 2 см;

- отступ справа в размере 0,5 см;

- интервал после абзаца 28 пт.

6.1.7 Для заголовков подразделов в работах студентов (стиль «_Подзаголовок») предусматриваются следующие параметры шрифта:

- Times New Roman, размером 14 пт;

- полужирное начертание.

и следующие параметры абзаца:

- выравнивание по левому краю;

- отступ слева в размере 2 см;

- отступ справа в размере 0,5 см;

- интервалы до и после абзаца 28 пт.

6.1.8 Для заголовков разделов в работах преподавателей Колледжа (стиль «_Раздел») предусматриваются следующие параметры шрифта:

- Times New Roman, размером 14 пт;

- полужирное начертание;

- все буквы прописные.

и следующие параметры абзаца:

- выравнивание по левому краю;

- отступ слева в размере 1 см;

- интервал после абзаца 24 пт.

6.1.9 Для заголовков подразделов в работах преподавателей Колледжа (стиль «_Подраздел») предусматриваются следующие параметры шрифта:

- Times New Roman, размером 12 пт;

- полужирное начертание.

и следующие параметры абзаца:

- выравнивание по левому краю;

- отступ слева в размере 1 см;

- интервалы до и после абзаца 24 пт.

6.1.10 Ссылки в тексте приводят следующим образом:

- при ссылках на сам текст: «в разделе 3», «в подразделе 3.1», «по 3.5.2»

или «по 5.4.3.1»; «по формуле (2.3)»; «на рисунке 4.3», «в таблице 5.2», «в приложении Б»;

- при ссылках на использованные источники:

«по [5], с. 128, формула (2.1)» – если заимствуются конкретные данные;

«в работе [3]» – если дается общая ссылка на работу;

«в работах [1, 2, 4 – 7]» – если дается общая ссылка на ряд работ;

«в работах А.Н.Иванова [1, 5]» – если необходимо указать фамилию (фамилии) автора (авторов) работ.

6.2 Оформление формул

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

Оформление формул в обоих случаях одинаково.

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

6.2.3 При вставке формулы в работах студентов устанавливаются следующие параметры табуляции (стиль «_Формула»):

- 9 см, с выравниванием по центру (перед формулой);

- 17,5 см, с выравниванием по правому краю (после формулы перед номером).

и следующие параметры шрифта внутри формулы:

- Times New Roman, 14 пт, наклонный (для стилей всех символов);

6.2.4 При вставке формулы в работах преподавателей Колледжа устанавливаются следующие параметры табуляции (стиль «_Формула»):

- 8,5 см, с выравниванием по центру (перед формулой);

- 17 см, с выравниванием по правому краю (после формулы перед номером).

и следующие параметры шрифта внутри формулы:

- Times New Roman, 12 пт, наклонный (для стилей всех символов);

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

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

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

Обозначение единиц величин непосредственно в формулах недопустимо.

6.2.7 Применяемые в формулах и расчетах единицы величин и их обозначения должны соответствовать ГОСТ 8.417.

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

6.2.8 Формулы следует нумеровать арабскими цифрами. Номер должен состоять из номера раздела, независимо от наличия его составных частей, и порядкового номера формулы в разделе, разделенных точкой.

Номер формулы указывают справа от формулы в круглых скобках на расстоянии, определяемом пунктами 6.2.3-6.2.4.

Например:

(3.12) – двенадцатая формула третьего раздела.

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

6.3 Оформление расчетов

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

6.3.2 Расчетные формулы необходимо оформлять в соответствии с подразделом 6.2. Их следует приводить, начиная с формулы, определяющей конечную цель расчета. Затем приводят формулы, определяющие величины, входящие в первую формулу. Так поступают до тех пор, пока не будут определены все входящие в формулы величины.

6.3.3 Числовые расчеты начинают с последних формул, подставляя затем найденные числовые значения в предыдущие формулы.

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

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

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

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

Например:

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

6.3.8 Пример оформления формул и расчета приведен в приложении А.

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

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

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

6.4.3 Иллюстрации следует нумеровать арабскими цифрами аналогично нумерации формул по 6.2.8.

Иллюстрации любого вида по 6.4.1 в соответствии с ГОСТ Р 1.5; ГОСТ2.105 и ГОСТ7.32 следует обозначать словом “Рисунок” (без сокращения) и номером иллюстрации.

6.4.4 Иллюстрации могут иметь наименования и пояснительный текст.

Пояснительный текст располагают под иллюстрацией.

Обозначение и наименование иллюстрации приводят под пояснительным текстом по следующей форме:

Например:

Рисунок 2.1 – Детали привода

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

6.4.6 Иллюстрации, предполагающие альбомную ориентацию листа, следует размещать в приложении.

6.5 Оформление таблиц

6.5.1 Таблицы применяют для повышения наглядности представления и удобства анализа цифрового материала, не представляемого в виде диаграмм, и оформляют в соответствии с ГОСТ Р 1.5; ГОСТ 2.105 и ГОСТ 7.32.

6.5.2 Таблицу следует располагать непосредственно после текста, в котором она упоминается впервые, или на следующей странице. Допустимо располагать таблицу вдоль длинной стороны листа.

6.5.3 На все таблицы должны быть ссылки в тексте в соответствии с 6.1.10.

6.5.4 Нумерацию таблиц следует производить аналогично нумерации формул по 6.2.8.

6.5.5 В соответствии со стандартами по 6.5.1 каждая таблица должна иметь шапку, где помещают заголовки и подзаголовки её граф.

6.5.6 Обозначение и, при необходимости, наименование таблицы приводят над ней, начиная с левого угла.

Пример:

Таблица 3.2 – Исходные данные

6.5.7 При переносе таблицы на другой лист ее наименование не приводят, а шапку повторяют, приводя над ней слова:

Пример:

Продолжение таблицы 3.2

6.5.8 Над последней частью таблицы приводят слова:

Пример:

Окончание таблицы 3.2

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

6.5.10 Недопустимо включать в таблицу графу «Номера по порядку» за исключением случая, когда требуются ссылки на номера позиций таблицы; при этом отдельную графу не выполняют, а номера указывают непосредственно перед наименованиями строк без точек.

6.5.11 При повторах одиночные слова, если они чередуются с цифрами, заменяют кавычками.

Пример:

От	до	15 вкл.
Св.	“	20 “
“	“	25 “

Два и более слов заменяют словами “то же” и далее кавычками. Цифры заменять кавычками недопустимо.

6.5.12 При отсутствии данных в таблице ставят прочерк.

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

В конце заголовков и подзаголовков точки не ставят.

Заголовки и подзаголовки указывают в единственном числе.

6.5.14 В одной графе таблицы должно быть одинаковое количество десятичных знаков после запятой для всех числовых значений.

6.5.15 Если все показатели, приведенные в таблице, выражены в одной и той же единице физической величины, то её обозначение необходимо помещать над таблицей справа, например: “В миллиметрах”. При переносе таблицы обозначение повторяют.

6.5.16 Пример оформления таблицы приведен в приложении Б – на рисунке Б.1 – начало таблицы (на первой странице), на рисунке Б.2 – окончание таблицы (на последней странице); на промежуточных страницах указывают – “Продолжение таблицы…” в соответствии с 6.5.7.

6.5.17 В случае размещения в таблице большого объема информации допускается уменьшение междустрочного интервала и/или уменьшение размера шрифта не более, чем на 1 пункт.

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

3 Титульный лист

7.1 Титульные листы для каждого вида документа устанавливаются соответствующим стандартом. Например, титульные листы пояснительных записок – стандартами СТП 4.02-2005, СТП 4.01-2005.

Требования по оформлению титульных листов для работ преподавателей Колледжа определены следующими документами: СТП 2.01-2005, СТП 2.02-2005, «Инструкция по делопроизводству».

4 Содержание

8.1 Содержание должно включать все составные части в соответствии с разделом 4, имеющиеся в работе после самого содержания.

8.2 По основной части в содержание включают разделы и подразделы, имеющие заголовки.

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

8.4 В содержании указывают номера страниц, на которых размещается начало составных частей без обозначений “с” или “стр” вверху.

8.5 Содержание оформляется как обычный текст по 5.2.4-5.2.5 без абзацного отступа.

8.6 Пример оформления содержания приведен в приложении В (рисунок В.1).

5 Перечень условных обозначений, символов и терминов

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

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

9.3 Пример оформления перечня условных обозначений, символов и терминов приведен в приложении В (рисунок В.2).

6 Введение

10.1 В работах студентов введение должно содержать оценку современного состояния и актуальности темы, основание для её разработки, постановку задачи и анализ исходных данных, изложенных в задании.

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

7 Заключение

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

11.2 Объем заключения – от 1 до 2 страниц.

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

8 Список используемых источников

12.1 Список используемых источников должен содержать все источники, использованные при выполнении работы.

12.2 В соответствии с ГОСТ 2.105 и 7.32 источники следует располагать в порядке появления ссылок в тексте.

12.3 В исключительных случаях допускается располагать источники в алфавитном или ином порядке.

12.4 Сведения об источниках приводят в соответствии с ГОСТ 7.1.

12.5 Список используемых источников оформляется как обычный текст по 5.2.4, 5.2.5 с указанием номеров источников с точкой после номера.

12.6 Пример оформления списка используемых источников приведен в приложении Г.

9 Приложения

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

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

13.3 Приложения обозначают последовательными прописными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. Если в работе одно приложение, его обозначают “Приложение А”.

13.4 Каждое приложение следует начинать с новой страницы с указанием вверху посередине страницы слова “Приложение” с его обозначением. Под ним указывают наименование приложения с прописной буквы.

13.5 Все страницы приложений должны иметь общую с остальной частью нумерацию страниц, как это указано в 5.3.2.

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

Пример:

Таблица Б.1.

13.7 Приложения, как правило, выполняют на листах формата А4. Допускаются также форматы А3, А4 ´ 3, А4 ´ 4. В исключительных случаях допустимы форматы А2 и А1 по ГОСТ 2.301.

13.8 При наличии в пояснительной записке документов, выполненных на формах по ГОСТ 2.310, в состав пояснительной записки следует включать ведомость проекта. Образец ведомости проекта приведен в приложении Д.

12 3 Следующая ⇒