Общие требования

Согласно ГОСТ 2.32-2001 пояснительная записка должна содержать следующие разделы:

*титульный лист;

*реферат;

*содержание;

нормативные ссылки;

определения;

обозначения и сокращения;

*введение;

*основная часть;

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

*список использованных источников;

приложения.

Обязательные структурные элементы отмечены звездочкой (*). Остальные разделы включают в пояснительную записку по усмотрению разработчика.

8.2 Реферат

Общие требования к реферату на пояснительную записку курсового или дипломного проекта изложены в ГОСТ 7.9-95 (ИСО 214-76) «Система стандартов по информации, библиотечному и издательскому делу. Реферат и аннотация. Общие требования».

Реферат должен содержать:

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

перечень ключевых слов;

текст реферата.

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

Текст реферата должен отражать:

объект исследования или разработки;

цель работы;

метод или методологию проведения работы;

результаты работы;

основные конструктивные, технологические и технико-эксплуатационные характеристики;

степень внедрения;

рекомендации по внедрению или итоги внедрения результатов курсовых или дипломных проектов);

область применения;

экономическую эффективность или значимость работы;

прогнозные предположения о развитии объекта исследования.

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

8.3 Содержание

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

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

В пояснительной записке объемом не более 10 страниц содержание допускается не составлять.

^ 8.4 Нормативные ссылки

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

Перечень ссылочных стандартов начинают со слов: «В настоящей пояснительной записке использованы ссылки на следующие стандарты».

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

8.5 Определения

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

Перечень определений начинают со слов: «В настоящей пояснительной записке использованы следующие термины с соответствующими определениями».

^ 8.6 Обозначения и сокращения

Раздел пояснительной записки «Обозначения и сокращения» содержит перечень обозначений и сокращений, применяемых в данной пояснительной записке (кроме общепринятых).

Запись обозначений и сокращений проводят в порядке приведения их в тексте отчета с необходимой расшифровкой и пояснениями.

Допускается определения, обозначения и сокращения приводить в одном разделе «Определения, обозначения и сокращения».

8.7 Введение

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

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

Во введении первой части пояснительной записки (если она состоит из двух и более частей) помещают перечень наименований всех отдельных частей по этапам проектирования. Первый лист введения пояснительной записки курсового или дипломного проекта должен иметь основную надпись по ГОСТ 2.104-68 (первый лист), в графе заголовок которой указывается тема курсового или дипломного проекта.

^ 8.8 Основная часть

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

Текст пояснительной записки должен быть кратким, четким и не допускать различных толкований. Первый лист каждого раздела основной части пояснительной записки курсового или дипломного проекта должен иметь основную надпись по ГОСТ 2.104-68 (первый лист), в графе заголовок которой указывается тема курсового или дипломного проекта, под которой меньшим шрифтом приводится название раздела. Децимальных номеров, отличных от номера пояснительной записки, разделы пояснительной записки не имеют, и наследуют децимальный номер всей пояснительной записки без изменений.

Представление в пояснительной записке данных о свойствах веществ и материалов проводятся по ГОСТ 7.5-88 «Система стандартов по информации, библиотечному и издательскому делу. Представление численных данных о свойствах веществ и материалов в научно-технических документах. Общие требования», единицы физических величин - по ГОСТ 8.417-81 «Государственная система обеспечения единства измерений. Единицы физических величин».

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примеры

1 Провести испытания пяти труб, каждая длиной 5 м.

2 Отобрать 15 труб для испытаний на давление.

Единица физической величины одного и того же параметра в пределах пояснительной записки должна быть постоянной. Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например 1, 50; 1, 75; 2, 00 м.

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

Примеры:

1 От 1 до 5 мм.

2 От 10 до 100 кг.

3 От плюс 10 до минус 40°С.

От плюс 10 до плюс 40°С.

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

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

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

Числовые значения величин в тексте следует указывать со степенью точности, которая необходима для обеспечения требуемых свойств изделия, при этом в ряду величин осуществляется выравнивание числа знаков после запятой. Округление числовых значений величин до первого, второго, третьего и т.д. десятичного знака для различных типоразмеров, марок и т.п. изделий одного наименования должно быть одинаковым. Например, если градация толщины стальной горячекатаной ленты 0, 25 мм, то весь ряд толщин ленты должен быть указан с таким же количеством десятичных знаков, например 1, 50; 1, 75; 2, 00. Дробные числа необходимо приводить в виде десятичных дробей.

8.9 Заключение

Заключение должно содержать:

краткие выводы по результатам выполненного проекта или отдельных его этапов;

оценку полноты решений поставленных задач;

оценку технико-экономической эффективности внедрения;

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

^ 8.10 Список использованных источников

Список должен содержать сведения об источниках, использованных при составлении отчета. Сведения об источниках приводятся в соответствии с требованиями ГОСТ 7.1-84 «Система стандартов по информации, библиотечному и издательскому делу. Библиографическое описание документа. Общие требования и правила составления».

8.11 Приложения

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

В приложения могут быть включены:

промежуточные математические доказательства, формулы и расчеты;

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

протоколы испытаний;

инструкции, методики, разработанные в процессе проектирования;

иллюстрации вспомогательного характера;

акты внедрения результатов проектирования и др.

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

В приложения к пояснительной записке курсового или дипломного проекта, в составе которого предусмотрено проведение патентных исследований, должен быть включен отчет о патентных исследованиях, оформленный по ГОСТ 15.011-82 «Система разработки и постановки продукции на производство. Порядок проведения патентных исследований», библиографический список публикаций и патентных документов, полученных в результате выполнения проекта, - по ГОСТ 7.1.

В тексте пояснительной записки на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте пояснительной записки, за исключением справочного приложения «Библиография», которое располагают последним.

Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «Приложение», его обозначения и степени. Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой. Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, Й, 0, Ч, Ь, Ы, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность. Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и O. В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами.

Если в пояснительной записке одно приложение, оно обозначается «Приложение А».

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