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

Размещено на http://www.allbest.ru/

Санкт-Петербургский государственный технический университет

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

Глубокоуважаемые коллеги - студенты и аспиранты СПбГТУ!

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

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

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

Назначение

Положение "Документы учебные текстовые. Структура и пра-вила оформления" (в дальнейшем - Положение -обязательно для студентов при оформлении учебных материалов по всем дисцип-линам на всех кафедрах СПбГТУ. Содержательная сторона тек-стовых учебных документов определяется кафедрами через систе-му учебных пособий, методических указаний и индивидуальных консультаций. Положение составлено на основе ряда государствен-ных стандартов, указанных в разд.5, а также с учетом опыта при-менения стандарта: Комплексная система управления качеством деятельности вуза. Учебный процесс. ДОКУМЕНТЫ ТЕКСТОВЫЕ УЧЕБНЫЕ. Общие требования, структура и правила оформления. Стандарт предприятия СТП ЛПИ 1.01-88. Преподавателям СПбГТУ при написании методических указаний и пособий по ла-бораторным и практическим занятиям, курсовому и дипломному проектированию и т.п. необходимо делать ссылку на настоящее Положение.

Состав, структура и общие правила оформления текстовых учебных документов

К текстовым учебным документам (ТУД) относятся: - диссертация на соискание ученой степени магистра (магистерская диссертация); - дипломный проект; - выпускная работа бакалавра; - курсовой проект, курсовая работа; - отчет о научно-исследовательской работе студента (НИР студента); - отчет по практике; - реферат на заданную (выбранную) тему; - расчетное задание, расчетно-графическое задание; - отчет по лабораторной работе.

Структура ТУД представлена в таблице. Обязательные структурные части ТУД отмечены в таблице знаком "+", рекомендуемые -знаком "р".

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

Разделы должны иметь порядковую нумерацию в пределах всей основной части ТУД. Номер указывается арабскими цифрами с точкой в конце. Подразделы нумеруют арабскими цифрами в пределах каждого раздела, используя точки, например: 1.3. (третий подраздел первого раздела). Пункты нумеруют арабскими цифрами в пределах подраздела, например: 1.3.2. (второй пункт третьего подраздела первого раздела). Нумерация частей текста с количеством уровней более трех в ТУД не рекомендуется.

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

Приложения имеют отдельную нумерацию (см. разд. 3.8). Ссылки на части текста выполняют, используя сокращенные записи, например: "приведено в разд.3.2"; "указано в п.3.3.1".

Содержащиеся в тексте перечисления выделяют арабскими цифрами со скобкой: 1), 2) и т.д., или вместо цифр ставят тире.

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

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

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

Исполнение текста

Текст ТУД следует набирать на компьютере и печатать на принтере. Допускается машинописное и рукописное оформление. Цвет печати (письма) - черный, синий, фиолетовый. Не рекомендуется использовать цветную (красную, зеленую) печать текста.

Бумага, форматы и шрифты

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

S=a-b, (3.1)

где S - площадь прямоугольника, м2; а и b - длины сторон прямоугольника, м.

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

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

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

Как правило, учебные тексты иллюстрируют графиками, диаг-раммами, схемами, чертежами, фотографиями. Все иллюстрации в ТУД называют рисунками. Рисунки нумеруют в пределах раздела, на-пример: Рис. 2.3 (третий рисунок второго раздела). Если в ТУД содер-жится только один рсунок, то его не нумеруют. На каждый рисунок должна быть ссылка в тексте, например "... приведено на рис. 2.3" или "... составим схему замещения (рис. 2.5)". При повторной ссылке на одну и ту же иллюстрацию указывают сокращенно слово "смот-ри", например: (см. рис. 2.3).

Техника исполнения

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

Состав рисунка

Рисунки должны иметь номер и название и могут иметь поясня-ющие надписи. Последние размещают выше номера и названия и ниже собственно рисунка (примеры оформления рисунков даны в тексте настоящего приложения).

На графиках, выражающих количественные зависимости (экс-периментальные или расчетные), должна быть координатная сетка (рис.2.3). При использовании клетчатой или миллиметровой бумаги сетку можно заменить делительными штрихами на осях. Стрелки на осях координат в этом случае ставить не принято. Цифры располагают ниже оси абсцисс и левее оси ординат, единицы измерения физических величин указывают по одной линии с цифрами. Обозначения пере-менных приводят по другую сторону оси. Значения переменных от-кладывают в линейном или логарифмическом масштабах.

Переменные следует обозначать символом (см. рис. 2.2), матема-тическим выражением (см. рис. 2.3) или словами. Последний вариант применяют, если переменная фигурирует в ТУД один раз и введение для нее специального обозначения нецелесообразно.

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

На одной координатной сетке допустимо изображать две или

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

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

Написание обозначений единиц физических величин

5 А; 8,2 Н; 12 Вт; 120° ; 15' ; 28% . Между последней цифрой числа и обозначением единицы физической величины следует оставлять пробел, исключение составляют знаки, поднятые над строкой. Не допус-кается перенос обозначения единиц на следующую строку.

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

При указании значений величин с предельными отклонениями следует заключать их в скобки, например (125,0 +0.1) кг.

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

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

Десятичные кратные и дольные единицы образуют с помощью приставок, например: кГц (килогерц), МВт (мегаватт), мкс (мик-росекунда).

Специфические приставки, связанные с двоичной системой счис-ления, используют в вычислительной технике. Наряду с основными единицами "бит" и "байт" употребляют единицы КБ (произносят "ки-лобайт", эквивалентно 1024 байт) и МБ (произносят "мегабайт", эк-вивалентно 1048576 байт).

Сокращения

Развитие науки и техники постоянно порождает новые сокращения, некоторые из которых становится практически общепри-нятыми в определенной области знаний. Например, в машино-строении: ЧПУ (числовое программное управление), САПР (сис-тема автоматизированного проектирования), ГПС (гибкая производственная система) и др. О возможности использования практически общепринятых сокращений автору ТУД следует про-консультироваться с преподавателем.

В конкретной ТУД бывает целесообразно ввести свои сокраще-ния, например, в дипломном проекте по ГПС это могут быть: ТСУ (терминальная система управления), АСТПП (автоматизированная система технологической подготовки производства) и т.д. Каждое из

вводимых сокращений должно быть определено при первом упоминании, например, в такой форме: " ... используется терминальная система управления (ТСУ). В состав ТСУ входят ...".

При большом числе сокращений их включают в особый перечень (см. разд.3.5).

Не допускаются следующие приемы сокращения текста:

- употребление в тексте математических знаков ">", "<", "=" и др., а также знаков "%" и "М"(номер) без цифр;

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

- применение индексов стандартов "ГОСТ", "ОСТ", "РСР" без регистрационного номера (например, нельзя писать: "ГОСТом предусматривается", следует указать номер стандарта);

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

Нумерация листов (страниц)

При односторонней печати (письме) нумеруют листы ТУД, при двухсторонней - страницы.

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

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

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

Правила оформления структурных частей текстовой учебной документации

Титульные листы этих видов ТУД оформляются по образцам, приведенным в приложениях 4,5. Желательно компьютерное оформление, как указано в п.3.1.1. Допускается рукописное оформление. В этом случае выделяемые фрагменты титульного листа пишут чертежным шрифтом с буквами высотой 7-10 мм (вид ТУД) и 5 мм (тема).

В титульном листе этих видов ТУД указывают кафедру, ведущую соответствующую дисциплину (наименование кафедры - в роди тельном падеже, см. п.3.1.1.).

Расчетные и расчетно-графические задания, отчеты по лабораторным работам

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

В титульном листе этих видов ТУД указывают кафедру, ведущую соответствующую дисциплину.

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

Реферат должен содержать: сведения об объеме реферируемого документа (количество страниц, иллюстраций и таблиц), перечень клю-чевых слов и текст реферата. Образец оформления реферата приве-ден в приложении 7. Рекомендуемый объем текста реферата составля-ет 500-1000 знаков.

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

Реферат оформляют в виде компьютерной распечатки.

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

Следует различать понятия реферат как структурная часть ТУД и реферат на заданную (выбранную) тему. Последний представляет собой самостоятельное исследование по литературным источникам, используемое в учебном процессе по некоторым дисциплинам.

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

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

Приложение 1. Алгоритм расчета параметров настройки Приложение 2. Текст программы расчета параметров настройки

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

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

Введение, основная часть, заключение

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

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

Следует обратить пристальное внимание на расстановку зна-ков препинания (тире, точки, двоеточия) в библиографических описаниях. Знаки используются при автоматизированной обработ-ке текстов. Например, двоеточие после названия города означает, что следующим идет описание издательства. Города Москву, Санкт-Петербург и Ленинград обозначают сокращенно, соответ-ственно М., СПб. и Л.

Приложения

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

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

- двухсторонняя печать в формате А4;

- односторонняя печать в формате А4;

- вписывание формул от руки.

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

Выпускные работы бакалавров

Источники разработки

Р-50-77-88 "ЕСКД. Правила выполнения диаграмм";

ГОСТ 7.1-84 "СИБИД. Библиографическое описание документа. Общие требования и правила составления";

ГОСТ 7.9-95 "СИБИД. Реферат и аннотация";

ГОСТ 7.32-91 "СИБИД. Отчет о научно-исследовательской работе. Общие требования и правила оформления";

ГОСТ 8.417-81 "ГСИ. Единицы физических величин".

Приложение 1

Титульный лист магистерской диссертации

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

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

Приложение 4

Примеры библиографических описаний

1. Васильев Ю.С., Колосов В.Г., Яковлев В.А. Интегрирующие инновации Санкт-Петербурга. - СПб.: Политехника, 1998. - 428 с.

Монография (учебник, справочник) центрального издательства при числе авторов больше трех и наличии редактора (редакторов):

2. Гибкое автоматическое производство / В.О-Азбель, В.А.Его-ров, А.Ю. Звоницкий и др.; Под общ.ред. СА.Майорова, Г.В.Орловс-кого, C-Н.Халкиопова. - Л.: Машиностроение, 1985. - 454 с. *

Отдельный том многотомного издания:

3. Савельев И.В. Курс общей физики. T.I. Механика. Молеку-лярная физика: Учеб. пособие для студентов втузов. - 2-е изд., пере-раб. - М.: Наука, 1982. - 432 с.

Учебные пособия издательства СПбГТУ:

4. Дорантес Д.Х.Туккель И.Л. Управление инновационными проктами: методология и инструментальные средства: Учеб. пособие / СПбГТУ, Ин-т инноватики. - СПб.: Изд-во СПбГТУ, 1997. - 93 с.

5.Расчет вала на прочность и жесткость: Учеб. пособие / П.А.Павлов, Л.К.Паршин, В.А.Шерстнев и др.; СПбГТУ. - СПб.:

Изд-во СПбГТУ, 1998. - 41 с.

Статьи из периодических изданий:

6. Шакиров М.А., Кияткин Р.П. Динамика электромагнитных сил при переходном скин-эффекте в прямолинейных шинопрово-дах // Электричество. - 1998. - N4. - с: 62-69.

7. Определение динамических характеристик аэрогелей в зоне энерговыделения мощного электронного пучка / Б.А.Демидов, В.П.Еф-ремов, М.В.Илькин и др. //Журн. техн. физики. - 1998. -т.68, вып. 10. -с. 112-120.