2018-02-14
304
Методические указания
по оформлению учебной документации
для студентов технических специальностей
Уфа
2011
Настоящие методические указания устанавливают общие требования к структуре и правилам оформления выпускных квалификационных работ (бакалаврских и дипломных работ, дипломных проектов, магистерских диссертаций), курсовых проектов (работ), отчетов о практике, расчетно-графических работ и рефератов. Они составлены в соответствии с требованиями действующих нормативных документов по оформлению технической документации и с учетом специфики учебной документации. Соблюдение содержащихся в них требований является обязательным для всех видов выпускных квалификационных работ (ВКР) и рекомендуемым для остальных видов учебной документации.
Методические указания предназначены для студентов технических специальностей.
Составители: Р.А. Башаров, доцент каф. ЭЭП
Н.Г. Вильданова, канд. филол. наук, проф. каф. РЯЛ
Ф.Ш. Забиров, канд. техн. наук, проф. каф. НГПО
|
|
|
М.Ю. Прахова, доцент каф. АТПП
Ю.А. Фролов, д-р техн. наук, проф. каф ТХНГ
С.С. Хайрудинова, канд. техн. наук, доц. каф ТМО
Под общей редакцией д-р техн. наук, проф.,
академика Р.Г. Шарафиева
Рецензенты: А.М. Муратшин, д-р техн. наук, проф., заслуженный
метролог РФ, зав. кафедрой стандартизации
и сертификации ГОУ ВПО УГАТУ
Б.К. Сушко, д-р техн. наук, проф. кафедры «Физика
и техника оптической связи» ГОУ ВПО «БашГУ»
© Уфимский государственный нефтяной технический
университет, 2011
Содержание
Введение ……………………………………………………………………… 4
1 Общие положения …………………………………………………………. 6
1.1 Объем пояснительной записки и общие правила выполнения текста 9
1.2 Рубрикация ……………………………………………………………….. 9
1.3 Сокращения слов в тексте. Условные обозначения
по ГОСТ 7.12-93 …………………………………………………………….. 11
1.4 Правила изложения текста ……………………………………………… 12
1.5 Единицы физических величин. Знаки в тексте ……………………….. 15
1.6 Формулы, выполнение расчетов ……………………………………… 19
1.7 Иллюстрации в текстовом документе ………………………………… 22
1.8 Построение таблиц ……………………………………………………… 24
|
|
|
1.9 Ссылки на источники информации ……………………………………. 29
1.10 Приложения …………………………………………………………… 29
1.11 Оформление расчетов на ЭВМ ………………………………………. 30
1.12 Проверка оформления работы ……………………………………….. 31
2 Основные надписи по ГОСТ 2.104-2006 ………………………………… 32
3 Спецификации, экспликации и ведомости перечня обозначений …… 34
4 Виды и типы схем. Общие требования к выполнению в соответствии
с ГОСТ 2.701-2008 ………………………………………………………….. 35
Приложение А Примеры некоторых фрагментов учебной
документации …………………………………………………………………. 39
Приложение Б Рекомендуемая форма отзыва и рецензии на ВКР ……... 57
Введение
Целью методических указаний является обучение студентов правильному оформлению учебной документации в соответствии с национальными стандартами.
Методические указания разработаны на основе следующих нормативно-технических документов:
- ГОСТ 7.32 – 2001. Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления;
- ГОСТ 7.1 – 2003. Система стандартов по информации, библиотечному и издательскому делу. Библиографическая запись. Библиографическое описание. Общие требования и правила составления;
- ГОСТ Р 7.0.5 – 2008. Система стандартов по информации, библиотечному и издательскому делу. Библиографическая ссылка. Общие требования и правила составления;
- ГОСТ 7.12-93. Система стандартов по информации, библиотечному и издательскому делу. Библиографическая запись. Сокращение слов на русском языке. Общие требования и правила;
- ГОСТ 8.417 – 2002. Государственная система обеспечения единства измерений. Единицы величин;
- Р 50-77-88. Единая система технологической документации. Правила выполнения диаграмм;
- ГОСТ 2.004-88. ЕСКД. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ;
- ГОСТ 2.104-2006. ЕСКД. Основные надписи;
- ГОСТ 2.105-95. ЕСКД. Общие требования к текстовым документам;
- ГОСТ 2.106-96. ЕСКД. Текстовые документы;
- ГОСТ 2.109-73. ЕСКД. Основные требования к чертежам;
- ГОСТ 2.301-68. ЕСКД. Форматы;
- ГОСТ 2.303-68. ЕСКД. Линии;
- ГОСТ 2.304-81. ЕСКД. Шрифты чертежные;
- ГОСТ 2.305-2008. ЕСКД. Изображения – виды, разрезы, сечения;
- ГОСТ 2.306-68. ЕСКД. Обозначения графических материалов и правила их нанесения на чертежах;
- ГОСТ 2.307-68. ЕСКД. Нанесение размеров и предельных отклонений;
- ГОСТ 2.321-81. ЕСКД. Обозначения буквенные;
- ГОСТ 2.316-2008. ЕСКД. Правила нанесения надписей, технических тербований и таблиц на графических документах. Общие положения;
- ГОСТ 2.701-2008. ЕСКД. Схемы. Виды и типы. Общие требования к выполнению;
- ГОСТ 7.9-95. Система стандартов по информации, библиотечному и издательскому делу. Реферат и аннотация. Общие требования;
- ГОСТ 21.101-97. Система проектной документации для строительства. Основные требования к проектной и рабочей документации;
- ГОСТ Р 21.1101-97. Система проектной документации для строительства. Основные требования к проектной и рабочей документации;
- ГОСТ 21.404-93. Система проектной документации для строительства. Правила выполнения рабочей документации автоматизации технологических процессов;
- ГОСТ 19.002-80. Единая система программной документации (ЕСПД). Схемы алгоритмов и программ. Правила выполнения;
- ГОСТ 19.003-80. ЕСПД. Схемы алгоритмов и программ. Обозначения условные графические.
Общие положения
Структура пояснительной записки учебной документации должна способствовать наиболее полному раскрытию заданной (избранной) темы и отдельных ее вопросов. Все ее части должны быть изложены в строгой логической последовательности и взаимосвязи.
|
|
|
Содержание работ следует иллюстрировать схемами, таблицами, диаграммами, графиками, фотографиями, рисунками и т. д.
Графическому материалу по тексту пояснительной записки необходимо давать пояснения, раскрывая суть принятого технического решения.
Общий объем учебной документации устанавливает кафедра.
Рекомендуется следующий порядок последовательного размещения элементов расчетно-пояснительной записки:
– титульный лист;
– задание (бланк задания устанавливается и выдается кафедрой);
– список исполнителей (при необходимости, например, при выполнении комплексного дипломного проекта);
– реферат;
– содержание;
– определения, обозначения и сокращения (при необходимости указываются в порядке упоминания в тексте);
– введение;
– основная часть (рекомендуемые разделы: технологический; технический; обзор источников информации; патентные исследования; специальный раздел; экономический; безопасность и экологичность и другие разделы с описанием решений, расчетов, таблиц, рисунков);
– заключение;
– список использованных источников;
– приложения.
Заголовки таких элементов структурного содержания, как список использованных источников, реферат, введение и т. д., за исключением разделов основной части, следует писать по центру рабочего поля прописными буквами с новой страницы без разбивки.
Титульный лист является первым листом документа. Номер на нем не ставится. При его заполнении необходимо соблюдать следующие правила: все слова на титульном листе, кроме должностей, пишутся полностью, без сокращений; перенос слов и подчеркивание не допускаются; точки ставятся только после инициалов; разрядка слов не допускается.
Тема ВКР должна начинаться с имени существительного и точно совпадать с темой, указанной в приказе о допуске к выполнению ВКР и утверждении их тем. При выполнении комплексной ВКР вначале указывается общая тема, а затем через точку – тема данной части. Образец оформления титульного листа приводится в конце методических указаний.
|
|
|
На титульном листе должны быть подписи консультантов по всем разделам ВКР, включая консультанта по технологическому и техническому разделу.
Все подписи должны быть сделаны черным цветом и сопровождаться обозначением календарной даты в формате ЧЧ.ММ.ГГГГ, например: 03.05.2009.
Дата проставляется под подписью.
В расшифровке подписи инициалы печатаются без пробела, перед фамилией – пробел, например: А.Б. Варламов.
Печать рецензента должна ставиться таким образом, чтобы подпись рецензента и дата были вне нее, т.е. она должна быть на словах РЕЦЕНЗЕНТ и его должность.
В ВКР, выполняемых под руководством заведующего кафедрой, в поле ДОПУЩЕН К ЗАЩИТЕ на титульном листе должна быть фамилия и подпись заместителя.
Вторым листом пояснительной записки является задание на ВКР, которое заполняется на специальном бланке (форма устанавливается кафедрой) от руки и также не нумеруется. В задании обязательно должен быть проставлен номер приказа на ВКР, а также должны быть подписи самого дипломника, руководителя ВКР и консультантов по всем разделам.
Все подписи должны быть сделаны черным цветом и сопровождаться обозначением календарной даты, записанной определенным образом, например, 23.05.2011.
Дата выдачи задания – на 3 – 4 дня позже даты приказа, утверждающего темы ВКР.
Третьей страницей пояснительной записки является реферат. Он начинается с указания объема пояснительной записки (без учета приложений), количества иллюстраций, таблиц, использованных источников и приложений. Далее следует перечень ключевых слов, которых может быть от 5 до 15; они записываются в строку, прописными буквами, через запятую, в именительном падеже.
Текст реферата состоит из следующих обязательных абзацев:
Объектом исследования является ……
В процессе исследования ……
Цель работы ……..
В результате исследования ……..
Опытно-конструкторские и технико-экономические показатели……
Степень внедрения ……. (если нет, необходимо указать «Внедрение отсутствует»)
Эффективность …….
При выполнении комплексной ВКР в реферате должно быть указано, какой частью ВКР является данная пояснительная записка.
Объем реферата не должен превышать одной страницы.
С реферата начинается проставление номера страницы (внизу по центру ставится арабская цифра 3). Пример оформления реферата приведен в конце методических указаний.
1.1 Объем пояснительной записки и общие правила выполнения текста
Пояснительная записка должна быть сжатой, конкретной, но в то же время содержать весь необходимый материал. Текст печатается на одной стороне листа через полтора межстрочных интервала, размер полей: левое - 30 мм, правое – 10 мм, верхнее – 15 мм и нижнее – 20 мм. Шрифт «Times New Roman», кегль 14, выравнивание текста по ширине страницы, абзацный отступ 1,25 см. Рекомендуется устанавливать автоматический перенос.
Страницы пояснительной записки должны иметь сквозную нумерацию. Номер страницы в учебной документации ставят посередине, внизу листа.
1.2 Рубрикация
Содержание пояснительной записки при необходимости может быть разделено на разделы. Разделы, если того требует изложение текста, делятся на подразделы.
Подразделы разбивают на пункты и подпункты.
Каждый раздел текстового документа начинается с нового листа и выделяется полужирным шрифтом.
Разделы и подразделы, пункты и подпункты должны быть пронумерованы. Номер раздела обозначают арабской цифрой без точки перед названием. Номер подраздела состоит из номеров раздела и подраздела, разделенных точкой; номер пункта подраздела состоит из номеров раздела, подраздела и пункта, разделенных точками. Аналогично строится и номер подпункта. Перед названием во всех случаях точка не ставится.
Внутри пунктов или подпунктов могут быть приведены перечисления.
Перед каждой позицией перечисления следует ставить дефис или, при необходимости ссылки в тексте документа на одно из перечислений, строчную букву, после которой ставится скобка без точки и текст со строчной буквы, после текста ставится точка с запятой. Не допускается использовать в перечислении компьютерные маркеры списка. Для дальнейшей детализации перечислений необходимо использовать арабские цифры со скобкой. Запись производится с абзацного отступа, как показано в примере оформления перечислений.
Каждый пункт, подпункт и перечисление записывают с абзацного отступа.
Названия разделов, подразделов, пунктов и подпунктов записывают в виде заголовков с прописной буквы с абзацного отступа. Расстояние между заголовком и текстом, заголовками раздела и подраздела должно быть равно 3 интервалам (1 «Enter»).
Переносы слов во всех заголовках, кроме пунктов и подпунктов, не допускаются. Кроме того, не допускается переносить текст после предлога (например, при переносе предложения «Выбор технических средств для автоматизации установки» предлог «для» должен перейти на вторую строчку).
Точку в конце заголовка разделов и подразделов не ставят, а пунктов и подпунктов - ставят. Если заголовок состоит из двух предложений, то их разделяют точкой. Заголовки не подчеркиваются и не берутся в кавычки.
Строка с любым заголовком не может быть последней строчкой на странице, после нее обязательно должна быть хотя бы одна строка обычного текста.
Пример рубрикации
Обзор методов и средств измерения уровня
1.1 Методы измерения
1.1.1 Гидростатический метод.
1.1.1.1 Пьезометрические уровнемеры. Одной из разновидностей гидростатических уровнемеров...........
1.1.1.2 Барботажные уровнемеры. Особенность этих уровнемеров......
1.1.2 Ультразвуковой метод.
1.2.................................................................
1.2.1.........................................................................
1.3 Сокращения слов в тексте. Условные обозначения
по ГОСТ 7.12-93 и ГОСТ 7.11-2004
В тексте все слова пишутся полностью, без сокращений, кроме установленных правилами русской орфографии, пунктуации, разрешенных к применению в аннотациях, рефератах и в списках использованных источников по ГОСТ 7.12-93.
В отдельных случаях в технических требованиях, основных надписях и таблицах на чертежах также допустимы сокращения. Перечни таких сокращений регламентированы ГОСТ 2.316-2008 и ГОСТ 21.101-97.
Не допускается сокращать слова, если при их употреблении возможно различное понимание текста.
Сокращения некоторых слов и словосочетаний, общепринятых в русском языке, приведены в таблице 1.
Таблица 1 – Перечень сокращений некоторых слов и словосочетаний,
общепринятых в русском языке
| Слово (словосочетание) | Сокращение | Условия применения |
| То есть И тому подобное И так далее И многие другие И прочее И другие | т.е. и т. п. и т. д. и мн. др. и пр. и др. | Во всех случаях В конце фразы То же >> >> >> |
Не следует сокращать словосочетания: так как, так что, главным образом, должно быть, таким образом, так называемый. Не рекомендуется начинать предложения с указанных словосочетаний, тем более в их сокращенном варианте.
Некоторые сокращения, использованные в отдельных случаях, но не являющиеся общепринятыми, должны быть даны в списке условных обозначений. Разрешается писать сокращенно часто повторяемые специальные названия, но в этом случае при первом упоминании обязательно приводится их полное название и в скобках – сокращенное. Например, «контрольно-измерительные приборы и аппараты (КИП и А)».
Произвольные словообразования применять не допускается. В таблице 2 приведены наиболее часто встречающиеся ошибки.
Таблица 2 – Ошибки словообразований
| Неправильно | Правильно |
| Мехобработка | Механическая обработка |
| Бортооборудование | Бортовое оборудование |
| Техпроцесс | Технологический процесс |
| Техдокументация | Техническая документация |
Слова maximum и minimum применяются в сокращенном виде только для индексов, например Umax, Umin. В тексте эти слова следует писать по-русски: максимальный, минимальный.
Сложносокращенные слова со значением собственного имени, образованные частично из начальных звуков, частично из усеченных слов, пишутся в первой части прописными буквами, во второй – строчными, например: ВНИИНефтемаш. Такие слова склоняются, например: ВНИИНефтемашем.
1.4 Правила изложения текста
Текст пояснительной записки излагают кратко, четко, исключая неоднозначное его толкование. Язык изложения должен быть простым, характерным для научных и технических документов. Применять обороты разговорной речи не допускается, рекомендуется избегать лишних вводных фраз и сложных оборотов. Сложные обороты необходимо заменять несколькими простыми.
Принятая в тексте терминология должна соответствовать установленной в стандартах, а при их отсутствии – общепринятой в научно-технической литературе.
Если в документе принята специфическая терминология, то в начале его должен быть приведен перечень применяемых терминов с соответствующими разъяснениями.
Если в документе специальные термины повторяются менее трех раз, перечень не составляют, а их разъяснения приводят в тексте при первом упоминании.
Не допускается применять:
- для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы);
- техницизмы, профессиональные жаргонные выражения и тавтологические словосочетания. В таблице 3 приведены примеры использования недопустимых выражений;
- слова и выражения, приведенные в левой колонке таблицы 4;
- иностранные слова и термины при наличии равнозначных слов и терминов в русском языке применять не допускается, например: пролонгировать – продлить; репродуцировать – воспроизводить, воспроизвести; превалировать – преобладать; лидировать – возглавлять, первенствовать.
Таблица 3 – Примеры недопустимых выражений
| Неправильно | Правильно |
| Выкид насоса | Нагнетательная линия насоса |
| Всас насоса | Всасывающая линия насоса |
| В теле трубы | В металле стенки трубы (трубопровода) |
Таблица 4 – Список слов и выражений
| Принятых к употреблению | Не принятых к употреблению |
| В декабре 2007 года | В декабре прошлого года |
| В декабре 2008 года | В декабре текущего года |
| Запрещается | Воспрещается |
| В дальнейшем | Впредь |
| Предлагаю | Вследствие чего предлагается |
| Изложенное выше | Вышеизложенное |
| Для сведения, для руководства | Для сведения и руководства |
| Точно | Досконально |
| Потому что, так как | Ибо |
| Указанное | Изложенное |
| Сильно | Изрядно |
| Постепенно | Исподволь |
| Который, которым | Каковой, коим |
| Когда, если | Коль скоро |
| Следует | Надлежит |
| Для | На предмет |
| Предлагаем, сообщаем | Настоящим предлагается |
| Пока | Покамест |
| Поэтому | Посему |
| По назначению следует | По принадлежности подобает |
| (Не писать слово “упомянутое”) | Приложение упомянутое |
| Добавить | Присовокупить |
| Усиленно | Сугубо |
| Такой | Таковой |
| Как будто | Якобы |
Наименования предметов, объектов, применяемые в тексте, подрисуночных надписях, таблицах и приложениях, должны быть одинаковыми.
1.5 Единицы физических величин. Знаки в тексте
Должны применяться единицы физических величин Международной системы единиц (СИ) и единицы, допускаемые к применению наравне с единицами СИ без ограничения срока. Кроме того, могут использоваться единицы, временно допускаемые к применению наравне с единицами СИ. Могут использоваться также десятичные кратные и дольные от перечисленных единиц измерения. В учебном процессе при необходимости разрешается рядом с обозначением единиц измерения в системе СИ в скобках указывать обозначение в ранее применяемой системе и наоборот.
Часто используемые физические величины, единицы которых даются в соответствии с ГОСТ 8.417-2002, приведены в таблице 5; единицы, допускаемые к применению наравне с единицами СИ, в таблице 6, а временно допускаемые к употреблению единицы – в таблице 7.
Таблица 5 – Основные, дополнительные и производные единицы
| Наименование величины | Единица | |
| Наименование | Обозначение | |
| Длина | метр | м |
| Масса | килограмм | кг |
| Время | секунда | с |
| Сила электрического тока | ампер | А |
| Термодинамическая температура | кельвин | К |
| Количество электричества (электрический заряд) | кулон | Кл |
| Электрическое напряжение, электрический потенциал, разность электрических потенциалов, электродвижущая сила | вольт | В |
| Электрическая емкость | фарад | Ф |
| Электрическое сопротивление | ом | Ом |
| Световой поток | люмен | лм |
| Освещенность | люкс | лк |
| Момент силы | ньютон-метр | Н×м |
| Поверхностное натяжение | ньютон на метр | Н/м |
| Динамическая вязкость | паскаль-секунда | Па×с |
| Кинематическая вязкость | метр квадратный на секунду | м2/с |
| Теплоемкость системы, энтропия системы | джоуль на кельвин | Дж/К |
| Удельная теплоемкость, удельная энтропия | джоуль на килограмм-кельвин | Дж/(кг×К) |
| Теплопроводность | ватт на метр-кельвин | Вт/(м×К) |
| Объемный расход | метр кубический в секунду | м3/с |
| Массовый расход | килограмм в секунду | кг/с |
| Удельное электрическое сопротивление | ом на метр | Ом×м |
| Коэффициент теплопередачи | ватт на квадратный метр-кельвин | Вт/(м2×К) |
| Удельная теплота фазового превращения, теплота сгорания топлива | джоуль на килограмм | Дж/кг |
| Активность катализатора | катал | кат |
| Коэффициент диффузии | метр квадратный в секунду | м2/с |
Кроме температуры по шкале Кельвина, допускается применять и температуру по шкале Цельсия, выраженную в градусах Цельсия (обозначение °С).
Таблица 6 – Единицы, допускаемые к применению наравне с единицами СИ
| Наименование величины | Единица | |
| Наименование | Обозначение | |
| Масса | тонна | т |
| Время | минута час | мин ч |
| Плоский угол | сутки градус минута секунда | сут …° …’ …” |
| Объем, вместимость | литр | л |
| Полная мощность | вольт-ампер | В×А |
| Реактивная мощность | вар | вар |
Допускается также применять другие единицы, получившие широкое распространение, например: неделя, месяц, год, век и т. д.
Таблица 7 – Единицы, временно допускаемые к применению
| Наименование величины | Единица | |
| Наименование | Обозначение | |
| Длина | морская миля | миля |
| Скорость | узел | уз |
| Частота вращения | оборот в секунду оборот в минуту | об/с об/мин |
| Давление | бар | бар |
Единица физической величины одного параметра в пределах всей пояснительной записки должна быть постоянной. Применять обозначения единиц физических величин без цифровых значений не допускается, в этом случае они пишутся без сокращений, например: толщина стенки трубы – в миллиметрах. Если в тексте приводится ряд цифровых величин с одинаковыми единицами физических величин, то они при них указываются один раз (при последнем числе).
В тексте не допускается применение без числовых или буквенных значений математических знаков: ³, £, =, ¹, °, log (lg, ln), sin, cos и др., а также знаков: №, %, °, t, Æ и др. Эти знаки в тексте пишут словами. Знаки №, % при нескольких числах ставят только один раз.
В тексте документа не допускается ставить математический знак минус (–) перед отрицательными значениями величин, а следует писать слово “минус”.
Индексы стандартов (ГОСТ, ОСТ и т. п.) без регистрационного номера и года издания не применяются.
Рубли и копейки в тексте сокращают: руб. и коп. Также они употребляются в головках и боковиках таблиц, при расшифровке символов формул без цифрового сопровождения. Если рубли и копейки пишутся после цифр, то сокращают так: 12 р. 33 к., а не 12 руб. 33 коп.
Порядковые числительные следует писать с указанием падежных окончаний (5-й насос, 5-м насосом, 6-го трубопровода, 6-му трубопроводу). При перечислении нескольких чисел окончания ставят только у последнего, например: в 1, 2 и 5-й линиях.
Не ставят падежные окончания в числительных, стоящих после существительных (например, в разделе 3), в количественных числительных, употребляемых вместе с существительными (например, на 20 страницах), в датах (например, 5 мая), а также с римскими цифрами.
При указании пределов величин (от минус 10 до плюс 20 0С) рекомендуется применять тире, например: рисунки 1 – 4, абсолютная шероховатость 0,1 – 0,2 мкм.
Выделение в тексте отдельных слов, фраз и предложений написанием вразрядку, прописными буквами, подчёркиванием, жирным или полужирным шрифтом не допускается.
1.6 Формулы, выполнение расчётов
Формулы набираются в одном из математических редакторов (Microsoft Equation 3.0, MathCad) с высотой знаков не менее 3,5 мм.
Для всех расчётов должна быть строго выдержана общая единая форма записи, приведена ссылка на источник, откуда взята расчётная формула, с необходимыми пояснениями принятых обозначений и их размерностей. Необходимо соблюдать следующую последовательность записи:
– искомая величина;
– формула, пояснение обозначений и их размерностей;
– числовая подстановка;
– в окончательном результате расчетов указывается единица физической величины.
В формулах не допускаются никакие промежуточные расчёты, преобразования и сокращения.
Формулы (уравнения) располагают с абзацного отступа. Строка формулы отделяется от верхнего и нижнего сплошного текста одной строкой (1 «Enter»). Расстояние между строками формулы такое же, как и между строками в тексте. В тех случаях, когда формула не помещается на одной строке, ее переносят в другую. Переносить формулу можно при математических знаках равенства (=) или после знаков плюс (+), минус (–), умножения (х) и деления (:), обязательно повторяя знак переноса на следующей строке.
Все формулы, если их более одной, нумеруются арабскими цифрами в пределах раздела. Номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой. Номер указывают в круглых скобках с правой стороны листа на уровне формулы. Допускается сквозная нумерация в пределах всего документа.
Ссылки в тексте на номер формулы дают в круглых скобках, например: «… в формуле (2.1)…», без кавычек.
Значения символов и числовых коэффициентов, входящих в формулу,
должны быть приведены непосредственно под формулой. Значения каждого символа дают всегда с новой строки в той последовательности, в какой он приведен в формуле. Первая строка расшифровки должна начинаться со слова «где», которое пишется с начала строки. Знаки препинания (двоеточие, тире и другие) после слова «где» не указываются. При необходимости (например, для эмпирических формул) после значения символа приводится единица физической величины через запятую. Не допускается в конце формулы, приведенной в символической (буквенной) форме, указывать единицу физической величины. Единица искомой величины должна быть указана в тексте перед формулой или под формулой.
Расшифровка символов, знаков, обозначений в формуле приводится слева направо. Расшифровку формулы, выраженной в виде дроби, приводят в такой последовательности: вначале числитель, а затем знаменатель.
Пример
Массу m нефтепродукта вычисляют по формуле:
m = ρv × V, (4.4)
где ρv – плотность нефтепродукта, приведенная к условиям измерения объема в резервуаре, кг/м3;
V - фактический объем нефтепродукта в резервуаре, м3.
Если формулы следуют друг за другом (без текста между ними), то они разделяются запятой и пишутся без пробела, например:
F= m·a,
F= P·S.
При числовой подстановке числа, которыми заменяются буквы формулы, должны стоять на тех же местах, которые занимала буква. Перестановки либо произвольная подстановка численных значений в формулах не допускаются.
В тех случаях, когда расчёты по одной и той же формуле повторяются многократно, формула должна быть записана в обычном виде, затем в ней должны быть сделаны числовые подстановки всех величин, постоянных для данной группы расчётов, наконец, все числа должны быть сведены в один общий числовой коэффициент. После этого оставшаяся часть расчётов может быть представлена в виде таблицы.
Если подбор технологического оборудования, расчет режимов его работы или выбор других процессов выполняется по единой методике,следует провести полный расчёт для одного варианта, а результаты расчётов по остальным вариантам представить в виде таблицы.
Если в документе приводится ряд величин одной размерности, единицу указывают только после последнего числа, например:
1,0; 1,5; 2,0 м.
Следует обратить внимание на правила пунктуации в текстовом документе с формулами.
Общее правило здесь такое: формула включается в предложение как его равноправный элемент. Поэтому в конце формул и в тексте перед ними знаки препинания ставят в соответствии с правилами пунктуации.
Двоеточие перед формулой ставят лишь в тех случаях, когда оно необходимо по правилам пунктуации:
- в тексте перед формулой содержится обобщающее слово;
- этого требует построение текста, предшествующего формуле.
Знаки препинания между формулами, следующими одна за другой и не разделёнными текстом, отделяют запятой или точкой с запятой. Эти знаки препинания помещают непосредственно за формулами до их номера.
Помимо буквенного обозначения единиц величин, входящих в формулы, в этих формулах могут быть использованы символы и индексы, позволяющие выделить эти величины из всей совокупности однородных величин.
Символ – это условное обозначение, во-первых, математических и физических величин, во-вторых, единиц физических величин и, в-третьих, математических знаков.
В качестве символов используются буквы русского, латинского, греческого и готического алфавитов. Чтобы избежать совпадения символов различных величин, применяются индексы.
Индексом могут служить строчные буквы русского, латинского и греческого алфавитов, арабские и римские цифры, штрихи. Располагаются индексы справа от символа, вверху или внизу. Однако верхние индексы используются крайне редко, так как это – место расположения степени.
При использовании символов и индексов необходимо соблюдать следующие требования:
- одна и та же величина в тексте всего документа должна быть обозначена одинаково;
- символы и индексы физических величин и их единиц измерения должны соответствовать ГОСТ 8.417-2002;
- буквенные индексы должны соответствовать начальным или наиболее характерным буквам наименования понятия или величины, на связь с которыми указывает индекс (например, Kp – константа равновесия);
- индекс 0 (ноль) необходимо использовать только в случаях, указывающих на начальные или исходные показатели.
При использовании в индексах сокращений после них ставится точка, кроме сокращений иностранных слов: max, min и др.
Следует помнить, что использование одного и того же символа для обозначения различных физических параметров и величин в пределах одного текстового документа недопустимо.
1.7 Иллюстрации в текстовом документе
Количество иллюстраций выбирается таким образом, чтобы оно было достаточным для пояснения излагаемого текста.
Все иллюстрации (чертежи, фигуры, схемы, графики или диаграммы, фотографии и т. п.) именуются рисунками. Они располагаются после их первого упоминания в тексте на этой же или следующей странице.
Иллюстрации нумеруются в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделённых точкой. На все иллюстрации должны быть ссылки в тексте, например: «В соответствии с рисунком Х.Х, продукт проходит следующие …» или «Усилитель постоянного тока (рисунок Х.Х) представляет собой …». Повторная ссылка на рисунок делается следующим образом: «Как видно (рисунок Х.Х), …».
При необходимости может быть использована сквозная нумерация. В случае сквозной нумерации иллюстраций в пределах всего документа при ссылках на эти иллюстрации следует писать «... показана в соответствии с рисунком Х».
Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например – Рисунок А.3.
Иллюстрации при необходимости могут иметь наименование и поясняющие данные (подрисуночный текст). Слово «Рисунок Х.Х» с номером иллюстрации и его наименованием, разделенными тире, помещают после поясняющих данных: первая строка по центру, остальные с начала следующей строки без абзаца (точка в конце наименования не ставится):
Рисунок Х.Х – Детали прибора для исследования скважинных
параметров
Если рисунок состоит из нескольких частей, обозначенных на нем буквами а), б) и т.д., то расшифровка этих частей приводится непосредственно под каждой частью (пример в приложении А).
Ссылку на такой рисунок в тексте следует выполнять так: «На рисунке Х.Х (а) показано …».
Если на иллюстрации изображены составные части изделия, то должны быть указаны номера позиций этих составных частей в пределах данной иллюстрации, которые располагают в возрастающем порядке, за исключением повторяющихся позиций.
Для электро- или радиоэлементов указываются позиционные обозначения, установленные в схемах данного изделия.
Исключение составляют электро- и радиоэлементы, являющиеся органами регулировки или настройки, для которых (кроме номера позиции) дополнительно указывают в подрисуночном тексте назначение каждой регулировки и настройки, позиционное обозначение и надписи на соответствующей планке или панели.
Допускается, при необходимости, номер, присвоенный составной части изделия на иллюстрации, сохранять в пределах всего текстового документа.
Для схем расположения элементов конструкции архитектурно-строительных чертежей зданий (сооружений) указывают марки элементов.
При ссылке в тексте на отдельные элементы деталей (отверстия, пазы, канавки, буртики и др.) их обозначают прописными буквами русского алфавита.
Указанные данные наносят на иллюстрацию согласно ГОСТ 2.109.
Иллюстрацию располагают так, чтобы её удобно было рассматривать без поворота документа или с поворотом против часовой стрелки на 90 градусов. Номер страницы в этом случае проставляется аналогично обычным страницам.
Оформление графического материала (чертежей) при выполнении курсового и дипломного проектирования рассмотрены в разделе 3.
1.8 Построение таблиц
Таблицы (табличную форму представления материала) применяют для лучшей наглядности и удобства сравнения материала.
Цифровой материал, а также другие данные оформляют в виде таблиц в соответствии с рисунком 2. Таблица состоит из горизонтальных рядов (строк) и вертикальных колонок (граф). В верхней части таблицы, называемой головкой, указываются заголовки граф, а при необходимости и подзаголовки граф. Диагональное деление головки таблицы не допускается. Заголовки строк, находящиеся в левой части таблицы, объединены в боковик таблицы.
Ширина таблицы должна соответствовать рабочему полю.
Таблица должна иметь заголовок (наименование), который следует выполнять строчными буквами (кроме первой прописной) и помещать над таблицей без абзацного отступа после слова «Таблица» и ее номера. Если заголовок располагается на нескольких строках, вторая и все последующие строки начинаются от рабочего поля. Между номером таблицы и ее заголовком ставят тире. Точка в конце заголовка не ставится. Интервал между текстом, предшествующим таблице, и ее наименованием, между наименованием таблицы и самой таблицей, а также между таблицей и последующим текстом, – полуторный (как в основном тексте).
Рисунок 2 – Схема оформления таблицы
Перенос части таблицы на ту же или другие страницы производится автоматически.
Заголовки граф, а также текст всех строк таблицы должны начинаться с прописной буквы, а подзаголовки граф – со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц знаков препинания (точек) не ставят. Заголовки указывают в единственном числе. Для сокращения текстов заголовков и подзаголовков отдельные понятия, если они пояснены в тексте или приведены в иллюстрации, разрешается заменять буквенными обозначениями, в том числе установленными ГОСТ 2.321-84. Например: D – диаметр, H – высота, L – длина.
Графу “№ п/п – номер по порядку” в таблицу не включают. При необходимости нумерации показателей, параметров и других данных порядковые номера их могут быть поставлены в боковике таблицы, непосредственно перед их наименованием без точки в соответствии с рисунком 3. Перед числовым значением величин и обозначением типов, марок и т. п. порядковые номера не проставляются.
Не допускается деление граф таблицы косыми линиями. Высота строк в таблице не менее 8 мм.
Таблица 3.2 – Значения измерений
| Наименование показателя | Значение | |
| в режиме 1 | в режиме 2 | |
| 1 Давление в колонне, МПа, не более 2 Температура низа колонны, ˚С 3 Температура верха колонны, ˚С | 0,5 220 170 | 0,8 235 185 |
Рисунок 3 – Пример нумерации показателей
Повторяющийся в графе текст, если он состоит из одного слова, заменяется кавычками; если же он состоит из двух и более слов, то при первом повторении его заменяют словосочетанием “То же”, а далее кавычками.
Вместо повторяющихся цифр, марок, типов, видов, знаков, математических и других символов, обозначений, а также сокращений русских слов ставить кавычки не допускается. Незаполненные места в таблице не допускаются. Если сведений по данной графе нет, то в графе ставится прочерк.
Классы чисел в графе должны находиться точно один под другим. Числовые величины в одной графе должны иметь одинаковое количество десятичных знаков.
Если все параметры таблицы имеют одинаковую размерность, то обозначение единицы физических величин помещают над таблицей в заголовке (рисунок 4); если различную, то обозначения единиц указывают в заголовках граф (рисунок 5). Если параметры в одной строке имеют одинаковую величину, то единицу указывают в соответствующей строке боковика таблицы (рисунок 3).
Таблица 3.3 – Параметры резьбовых соединений
В миллиметрах
| Номинальный диаметр резьбы болта, винта, шпильки | Внутренний диаметр резьбы | Толщина шайбы | |||||
| лёгкой | нормальной | тяжёлой | |||||
| а | В | а | В | а | В | ||
| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
| 2,0 | 2,1 | 0,5 | 0,8 | 0,5 | 0,5 | – | – |
| 2,5 | 2,6 | 0,6 | 0,8 | 0.6 | 0,6 | – | – |
| 3,0 | 3,1 | 0,8 | 1,0 | 0,8 | 0,8 | 1,0 | 1,2 |
Рисунок 4 – Оформление таблицы с одинаковой размерностью
параметров
Таблица 2.1 – Характеристики изоляторов
| Тип изолятора | Номинальное напряжение, В | Номинальный ток, А |
| ПНР-6/400 | 6 | 400 |
| ПНР-6/800 | 800 |
Рисунок 5 – Оформление таблицы с различной
размерностью параметров
Над заголовком таблицы, над её левым углом указывается слово «Таблица» с порядковым номером либо в пределах раздела, либо в пределах всего документа. При ссылке в тексте слово «таблица» пишется полностью, начиная со строчной буквы без кавычек, например: «Основные характеристики элемента приведены в таблице 3.2, например…». Если в документе или разделе документа только одна таблица, номер ей не присваивают и слово «Таблица» не пишут.
Если строки или графы таблицы выходят за формат листа, то таблицу делят на части, которые либо переносят на другие страницы, либо помещают на одном листе рядом, либо одну часть под другой.
Если части таблицы помещают рядом, то в каждой части повторяют головку; при размещении частей таблицы одна под другой повторяют боковик.
Таблицу следует помещать после первого упоминания о ней в тексте. Допускается оформлять таблицы в виде приложений и помещать в конце текста. В этом случае таблица обозначается, например, Таблица Б.1, где Б - обозначение приложения.
При расположении таблицы вдоль длинной стороны листа головку таблицы располагают так, чтобы для её чтения документ надо было поворачивать против часовой стрелке.
В таблицах допустимо использование более мелкого шрифта (кегль 12).
1.9 Ссылки на источники информации
В тексте документа обязательно должны присутствовать ссылки на использованные при его составлении источники информации, библиографическое описание которых приводится в списке использованных источников в конце документа. Нумерация источников производится по мере их упоминания в тексте.
Ссылки на источник приводятся в квадратных скобках, например: [1]. В работе должны быть ссылки на все источники, перечисленные в списке.
Если ссылка стоит в конце предложения, точка ставится после ссылки.
1.10 Приложения
Иллюстрационный материал, таблицы, схемы, чертежи, спецификации, алгоритмы, программы, копии, промежуточные математические, физические и другие доказательства, описание вспомогательного оборудования, средств измерения и контроля, химических веществ и др. могут быть оформлены в виде приложений, помещаемых в конце документа или в виде отдельного документа. Все приложения должны быть пронумерованы и перечислены в содержании документа с указанием их номеров и заголовков.
Каждое приложение должно начинаться с нового листа (страницы) с указанием вверху листа слова ПРИЛОЖЕНИЕ прописными буквами без кавычек и его обозначения. Под ним в скобках указывается назначение приложения: для обязательного приложения пишут (обязательное), а для информационного – (рекомендуемое) или (справочное). При необходимости приложение может иметь заголовок, который записывается симметрично тексту с прописной буквы под словом ПРИЛОЖЕНИЕ отдельной строкой.
Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением Ё, 3, Й, О, Ч, Ъ, Ы, Ь, например: ПРИЛОЖЕНИЕ В.
Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и О.
В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами.
Если в документе одно приложение, оно обозначается ПРИЛОЖЕНИЕ А.
Приложения, как правило, выполняют на листах формата А4. Допускается выполнять приложения на листах формата АЗ, А4х3, А4х4, А2 и А1 по ГОСТ 2.301-68.
Текст каждого приложения, при необходимости, может быть разделён на разделы, подразделы, пункты, подпункты, которые нумеруют в пределах каждого приложения.
Иллюстрации и таблицы нумеруют в пределах каждого приложения, например: Рисунок Д.1, Таблица Е.2 и т. д.
При оформлении приложения как продолжения документа листы (страницы) имеют сквозную нумерацию, общую с документом. Исключение составляют приложения в виде текста, разбитого на графы (спецификация, ведомости, экспликации и т.п.), выполняемые, как правило, к чертежам. Эти документы выполняются с основной надписью по форме 2 по ГОСТ 2.104-2006. При необходимости такое приложение может иметь содержание.
Допускается в качестве приложения к документу использовать другие самостоятельно выпущенные конструкторские документы (габаритные чертежи, схемы и др.).
В тексте основного документа должны быть ссылки на приложения.
Приложения располагаются в порядке упоминания их в тексте.
1.11 Оформление расчетов на ЭВМ
При использовании существующей программы расчёта вначале излагают методику расчёта с обоснованием исходных данных либо дают пример ручного счёта для одного варианта исходных данных. Затем приводят распечатку программы и результаты расчёта. В завершение расчета необходим анализ результатов и выводы.
Если студент самостоятельно разработал программу расчёта, то после изложения методики расчета следует привести блок-схему расчёта, условные обозначения, программу расчёта, результаты расчёта и их анализ, выводы.
Допускается распечатки на ЭВМ (принтере) помещать в качестве приложений и складывать по формату листов дипломного проекта (работы).
1.12 Проверка оформления работы
После завершения разработки всех разделов пояснительной записки и их компоновки согласно содержанию необходимо проверить:
- соответствие заголовков текста содержанию, помещённому в начале записки;
- соответствие текста нормам русской речи;
- соответствие и однообразие условных обозначений и сокращений;
- правильность ссылок на формулы, таблицы, рисунки, приложения, литературные источники;
- наличие расшифровки всех буквенных символов и их повторов;
- наличие нумерации у всех таблиц, рисунков, формул, приложений, страниц записки;
- наличие списка использованных источников в порядке упоминания в тексте и ссылок на них.
