ОБЩИЕ ТРЕБОВАНИ К ОФОРМЛЕНИЮ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ



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

- объем пояснительной записки без приложений должен составлять 40-60 страниц;

- цифровые, табличные и прочие иллюстративные материалы могут быть вынесены в приложения;

- на титульном листе (приложение А или Б) должны быть подписи студента, руководителя работы и рецензента с указанием дат, а также подпись директора колледжа на допуске к защите;

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

Общие требования по составлению текстовых документов изложены в действующем стандарте ГОСТ 7.32-2001 (ред. 2006) «Отчет о научно-исследовательской работе. Структура и правила оформления», который можно найти в Интернете на сайте Федерального агентства по техническому регулированию и метрологии.

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

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

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

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

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

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

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

Рассмотренный выше порядок нумерации в пояснительной записке показан в примере.

Пример

1 Состояние проблемы по теме ВКР

1.1 Обзор информации по проблеме прогнозирования состояний объекта

1.2 Анализ требований технического задания

1.3 Патентный поиск

1.4 Выбор и обоснование метода прогнозирования

1.4.1 Формирование требований и ограничений на принятый метод прогнозирования

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

- ____________________________________

- ____________________________________

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

а) ____________________________________

б) ____________________________________

Нумерация страниц сплошная, номер ставится в центре нижней части листа, на первой странице (титульный лист) номер не ставится. Формат страницы – А4, шрифт – TimesNewRoman, размер шрифта 14, интервал 1,5. Поля: верхнее и нижнее – 20 мм, левое – 30 мм, правое – 10 мм.

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

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

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

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

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

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

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

- применять сокращения слов, кроме установленных правилами русской орфографии и соответствующими стандартами (ГОСТ 7.12-93);

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

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

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

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

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

Пример

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

(3.2)

где m – масса образца, кг; V – объем образца, м3.

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

В тексте пояснительной записки на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте. Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «Приложение» и его обозначение. Обозначение приложений выполняют заглавными буквами русского алфавита, начиная с А (за исключением букв Ë, З, Й, О, Ч, Ъ, Ы, Ь). Исходные тексты программного продукта, запросы к БД и другие листинги оформляются моношириннымшрифтом CourierNew, размер – 12, интервал – 1. Использование более одной пустой строки-разделителя в приложениях запрещается.

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

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

Пример

Рисунок 1.3 – Физическая модель базы данных

При ссылках на иллюстрации следует писать «...в соответствии с рисунком 1.3», не применяя сокращение «рис.».

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

Пример 1

1 - носовой отсек; 2 - боевая часть; 3 - зона подвески; 4 - отсек управления; 5 - автопилот; 6 - вычислитель; 7 - приводы рулей; 8 – хвостовое оперение

Рисунок 2.7 - Управляемая авиационная ракета

Пример 2

Рисунок 12 – Графики радиационной стойкости материалов и изделий электронной техники при воздействии нейтронов (а) и суммарной дозы ионизирующего излучения (б)

Иллюстрации, как правило, выполняют с книжным или альбомным расположением. Допускается оформлять иллюстрации отдельно на листах формата А4, А3. Иллюстрации на листах большего формата выносят в приложения.

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

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

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

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

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

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

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

Шапка таблицы должна быть отделена линией от остальной части таблицы.

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

Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными соответствующими стандартами или другими обозначениями, если они пояснены в тексте, например, D - диаметр, Н - высота, L - длина.

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

Пример

Таблица 3.12 – Характеристики электродвигателя

Наименование характеристики

Значение параметра

вхолостом режиме в режиме нагрузки
1 Ток коллектора, А 5, не менее 7, не более
2 Напряжение на коллекторе, В - 220
3Сопротивление нагрузки коллектора, Ом - -

 


Дата добавления: 2018-05-09; просмотров: 322; Мы поможем в написании вашей работы!

Поделиться с друзьями:






Мы поможем в написании ваших работ!