Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
СТП_оформление_документов_АиСУ.doc
Скачиваний:
5
Добавлен:
09.08.2019
Размер:
3.08 Mб
Скачать
    1. Формулы

Определенные требования предъявляются к формулам и уравнениям, приводимым в пояснительной записке. Формулы или уравнения располагаются на отдельной строке. Их следует рассматривать как составную часть предложения, которое они поясняют. Формул или уравнений вне предложений в пояснительной записке не может быть. Все формулы нумеруются в пределах раздела арабскими цифрами, которые помещают у правого края страницы и заключают в круглые скобки. Номер формулы должен состоять из номера раздела и порядкового номера формулы, разделенных точкой, например (3.1) – первая формула третьего раздела. Если какая-либо формула является разновидностью приведенной ранее формулы, ее нумеруют тем же номером что и исходная формула и добавляют строчную (малую) прямую букву русского алфавита (без пробела и без запятой между номером и буквой), например, (4.1а).

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

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

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

Формулы должны быть оформлены в редакторе формул Equation Editor и вставлены в документ как объект. Размеры шрифта для формул:

  1. обычный – 14 пт;

  2. крупный индекс – 8 пт;

  3. мелкий индекс – 8 пт;

  4. крупный символ – 20 пт;

  5. мелкий символ – 14 пт.

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

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

,

(1.1)

где iУД – ударный ток короткого замыкания в кА;

IП0 – начальное действующее значение периодической составляющей тока короткого замыкания в кА;

КУД – ударный коэффициент.

Допускается обозначение единицы измерения величины, стоящей в левой части формулы, помещать в тексте перед формулой, отделив его от основного текста запятыми (т.е. поставив перед обозначением единицы и после него запятые), например: «Для определения ударного тока короткого замыкания iУД, кА, используют выражение

,

(1.2)

где IП0 – начальное действующее значение периодической составляющей тока короткого замыкания в кА;

КУД – ударный коэффициент».

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

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

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

Между последней цифрой числа и обозначением единицы следует оставлять пробел, например: 100 кВт, 20 ºС.

При применении производной единицы, состоящей из двух и более единиц, не допускается комбинировать буквенные обозначения единиц и наименования единиц, т.е. для одних единиц приводить обозначения, а для других – наименования. Например, правильно: 80 км/ч или 80 километров в час; неверно: 80 км/час или 80 км в час.

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

  1. обозначения единиц, образующих произведение, разделяют точками, поднятыми на середину строки (например, Втс). При этом обозначение метра (м) или секунды (с) не ставят впереди какого-либо другого обозначения, если оно имеет первую степень; обозначения, возведенные в степень, располагают последними, например: см2;

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

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

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

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

Порядок изложения в документах математических уравнений такой же, как и формул.

Буквенные обозначения наиболее употребляемых физических величин приведены в приложении А.

    1. Ссылки

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

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

При ссылках на структурные части текста технической документации указывают номера разделов (со словом «раздел»), приложений (со словом «приложение»), подразделов, пунктов, подпунктов, перечислений, например: «....в соответствии с разделом 2», «... согласно 3.1», «.., по 3.1,1»; «...в соответствии с 4.2.2, перечисление 6»; «... как указано в приложении М».

Ссылки в тексте на номер формулы дают в скобках, например: «...согласно формуле (В.1)»; «...как следует из выражения (2.5)».

Ссылки в тексте на таблицы и иллюстрации оформляют по типу: (таблица 4.3); «... в таблице 1.1, графа 4»; (рисунок 2.11); «... в соответствии с рисунком 1.2»; «... как показано на рисунке В.7, поз. 12 и 13».

Ссылки на чертежи и схемы, выполненные на отдельных листах, делают с указанием обозначений, например: «...как показано на схеме ФЮРА. 443322.003 ЭЗ, элементы С12-С17, R20-R25…»; (чертеж общего вида ФЮРА. 482211.018 ВО); «... поз.5, 18-24 сборочного чертежа ФЮРА.483899.002 СБ»

При ссылке в тексте на использованные источники следует приводить порядковые номера по списку использованных источников, заключенные в квадратные скобки, например: «... как указано в монографии [103]»; «...в работах [11, 12, 15-17]».

При необходимости в дополнение к номеру источника указывают номер его раздела, подраздела, страницы, иллюстрации, таблицы, например; [С12, раздел 2]; [18, подраздел 1.3, приложение А]; [19, с. 28, таблица 8.3].

    1. Нумерация страниц пояснительной записки

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

  1. Структура документа

    1. Основные разделы

Текстовый документ должен включать в себя основные элементы:

  1. титульный лист;

  2. задание;

  3. реферат;

  4. содержание;

  5. введение;

  6. основная часть;

  7. заключение;

  8. библиографический список;

  9. приложения.

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

      1. Титульный лист

Титульный лист является обязательным для всех видов документов. Титульный лист выполняют на листе формата А4. На титульном листе не должно быть никаких сокращений. В общем случае титульный лист должен содержать наименование ведомства, в которое входит ВУЗ, ВУЗа, кафедры, название работы, вид работы, сведения о студенте, руководителе, консультантах (если есть), а также выходные данные. Название работ на титульном листе всегда выполняется прописными буквами, остальные элементы – строчными с первой прописной. Наименование ведомства располагается по верхней границе листа и выравнивается по центру страницы. Название ВУЗа располагается симметрично наименованию ведомства с принятым по всему документу межстрочным интервалом. Название кафедры пишется в именительном падеже в кавычках на расстоянии от названия ВУЗа равному удвоенному межстрочному интервалу. В дальнейшем любые упоминания названий кафедр приводятся в принятом для ВУЗа сокращенном виде без пробелов между буквами, например АиСУ, ЭЖТиУК, БЖиЭ и т.д.). При необходимости с правой стороны приводят гриф утверждения (титульный лист пояснительной записки к дипломному проекту). Под названием темы работы приводится вид текстового документа работы:

  1. тематический реферат по дисциплине;

  2. пояснительная записка;

  3. лабораторная работа № по теме.

Курсовые работы, дипломные и курсовые проекты должны содержать базовое обозначение документа, состоящее из буквенного кода ВУЗа, вида студенческой работы, номера варианта, номера задачи (номер приказа), резервного блока и буквенного кода документа. Для ОмГУПСа буквенный код имеет вид ИНМВ. Код студенческой работы в зависимости от типа документа имеет вид:

  1. дипломный проект – цифра 1;

  2. дипломная работа – цифра 2;

  3. курсовой проект – цифра 3;

  4. курсовая работа – цифра 4;

  5. графическая работа – цифра 5;

  6. лабораторная работа – цифра 6;

  7. практическая работа – цифра 7;

  8. тематический реферат – цифра 8.

Номер варианта выбирается либо преподавателем (курсовые работы и проекты, рефераты), либо в соответствие с номером темы в приказе (для дипломных проектов и работ).

Резервный блок не заполняется (указываются три подряд идущих символа нуля).

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

Таблица 2.1

Наименование документа

Код

Виды схем:

  1. электрическая;

  2. гидравлическая;

  3. пневматическая;

  4. кинематическая;

  5. вакуумная;

  6. оптическая;

  7. энергетическая;

  8. деления;

  9. комбинированная.

Ведомость спецификаций

Ведомость эксплуатационных документов

Генеральный план

Генеральный план сооружения транспорта

Инструкции

Маршрутная карта

Операционная карта

Паспорт

Пояснительная записка

Программа и методика испытаний

Прочие документы

Расчеты

Руководство по эксплуатации

Сооружения транспорта

Технология производства

Таблицы

Таблицы к схемам

Э

Г

П

К

В

Л

Р

Е

С

ВС

ВЭ

ГП

ГТ

И

МК

ОК

ПС

ПЗ

ПМ

Д

РР

РЭ

ТР

ТХ

ТБ

Т

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

Наименование документа

Код

Технические условия

Типы схем:

  1. структурная;

  2. функциональная;

  3. принципиальная (полная);

  4. соединений (монтажная);

  5. подключения;

  6. общие;

  7. расположения;

  8. объединенные.

Учебно-технические плакаты

Формуляр

Чертежи:

  1. сборочный;

  2. габаритный;

  3. теоретический;

  4. монтажный;

  5. ремонтный;

  6. общего вида;

  7. электромонтажный;

  8. упаковочный.

ТУ

1

2

3

4

5

6

7

0

УП

ФО

СБ

ГЧ

ТЧ

МЧ

Р

ВО

МЭ

УЧ

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

По нижней границе титульного листа указывается город и год составления документа

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

    1. Реферат

Реферат (ГОСТ 7.9, ГОСТ 7.32) размещается на отдельном листе (странице). Объем реферата должен составлять 0,5 – 1 страницу.

По рекомендации кафедры реферат либо заключение (см. п. 2.8) должен быть переведен на иностранный язык.

Реферат размещается на отдельной странице. Реферат должен содержать:

  1. индекс универсальной десятичной классификации (УДК);

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

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

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

Индекс УДК пишется с левой стороны страницы реферата без абзацного отступа.

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

Текст реферата (в общем случае) должен отражать:

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

  2. цель работы;

  3. метод исследования и аппаратуру;

  4. полученные результаты и их новизну;

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

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

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

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

  9. предположения о развитии объекта исследования (разработки);

  10. дополнительные сведения.

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

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

Пример оформления реферата приведен в приложении Е.

    1. Задание

Задание должно быть составлено на русском языке и, в общем случае, содержать:

  1. название темы;

  2. срок сдачи студентом законченной разработки;

  3. исходные данные;

  4. содержание пояснительной записки;

  5. перечень графического материала;

  6. список консультантов;

  7. дату выдачи задания;

  8. календарный план.

Тему задания определяют на кафедре. Формулировка темы выпускной квалификационной работы в задании должна точно соответствовать ее формулировке в приказе по ВУЗу. Пример оформления задания на дипломный проект приведен в приложении Ж.

    1. Содержание

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

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

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

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

Пример оформления содержания приведен в приложении И.