РЕКОМЕНДАЦИИ ПО ПОДГОТОВКЕ И ОФОРМЛЕНИЮ
ВЫПУСКНЫХ КВАЛИФИКАЦИОННЫХ РАБОТ
для студентов кафедры «Системный анализ и управление» ФТК СПбГПУ
1. ОБЩИЕ ЗАМЕЧАНИЯ
1.1. В настоящем документе представлены основные требования и рекомендации,
связанные с подготовкой и оформлением выпускной квалификационной работы. В тексте
документа в основном используется термин «магистерская диссертация», но следует
иметь в виду, что основная часть рекомендаций может быть использована также при подготовке других квалификационных работ (курсовых, бакалаврских, дипломных, отчетов по НИР и т.п.). Предлагаемые рекомендации соответствуют требованиям Государственных стандартов РФ ГОСТ 2.105-95 "ЕСКД. Общие требования к текстовым документам";
ГОСТ 7.1-84 "СИБИД. Библиографическое описание документа. Общие требования и правила составления";
ГОСТ 7.9-95 "СИБИД. Реферат и аннотация";
ГОСТ 7.32-91 "СИБИД. Отчет о научно-исследовательской работе. Общие требования и правила оформления";
ГОСТ 8.417-81 "ГСИ. Единицы физических величин", а также практике их применения при подготовке выпускных квалификационных работ в СПб ГПУ.
1.2. Традиции кафедры требуют, чтобы магистерская диссертация (дипломная работа) подтверждала Вашу способность выполнять сложную инженерную и исследовательскую работу на современном уровне.
2. ВЫБОР И УТВЕРЖДЕНИЕ ТЕМЫ ВЫПУСКНОЙ РАБОТЫ
2.1.Тема должна быть:- актуальной, т.е. связанной с решением практически ценной задачи на современном уровне;
- соответствующей специальности кафедры, т.е. требующей знания изученных дисциплин;
- достаточно сложной, нетривиальной, предполагающей применение элементов научного исследования.
2.2. Научный подход предполагает:
1. Общность постановки задачи, ее математическую формулировку.
2. Обзор литературы, ее сравнительный анализ.
3. Применение методов аналитического и численного моделирования и анализа.
4. Строгое обоснование решений: доказательство утверждений, количественные оценки, анализ моделей, натурные измерения.
5. Сравнительный анализ альтернативных решений и обсуждение полученных результатов.
2.3. Название диссертации должно быть лаконичным и отражать ПРЕДМЕТ разработки.
Не следует называть "Исследование и разработка системы цифровой фильтрации для...", лучше просто: "Система цифровой фильтрации для...". Нельзя предметом считать свойство: "Точность бомбометания...", правильнее: "Программная система статистической оценки точности бомбометания...". Вместо "Метод расчета напряжений..."
лучше назвать "Метод и программа расчета напряжений..." или "Пакет программ расчета...".
2.4. Тема магистерской диссертации (дипломной работы) должна быть окончательно сформулирована во время преддипломной практики, которая официально длится 2 месяца (обычно январь-февраль), но для многих, при наличии научного руководителя, начинается на несколько месяцев раньше. Одновременно нарабатывается задел работы: изучение литературы, варианты постановки задачи и т.д.
Тема диссертации (диплома) утверждается на защите отчета по практике в начале марта.
На защиту магистрант (дипломник) предъявляет:
- отчет по практике на 2 - 3 страницах с изложением выполненной подготовительной работы, подписанный руководителем практики, - черновик задания по дипломному проектированию; после его утверждения заполняется бланк.
2.5. Структура и содержание задания на дипломное проектирование.
В пп.1-2 Задания записывается фамилия студента и название темы.
В п.3 («Исходные данные») поясняется цель работы и технический контекст: ЭВМ, ОС, окружение (частью какой системы должна стать разработка дипломника).
В п.4 («Cодержание расчетно-пояснительной записки») записывается оглавление будущей работы на уровне разделов. Разумеется, оглавление (как и название) может изменяться в ходе работы, но основные вопросы, подлежащие разработке, определяются на этом этапе.
Пп.5 и 6 заполнять не обязательно.
Задание заполняется, подписывается руководителем и студентом с указанием даты подписи. Только после предъявления подписанного задания отчет по практике считается принятым; оценка выставляется в зависимости от качества и объема выполненной на практике работы. Задание остается у магистранта (дипломника), и перед защитой прилагается к тексту диссертации (но не подшивается к нему).
Руководитель магистранта (дипломника) окончательно утверждается во время защиты отчета по преддипломной практике. Если руководитель не является сотрудником кафедры, дополнительно назначается куратор из числа преподавателей кафедры, чья обязанность - следить за соответствием содержания работы требованиям, перечисленным в начале настоящего раздела.
3. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ РАБОТЫ
3.1. Структура текста диссертации.3.1.1. Вводная часть работы Эта часть квалификационной работы должна быть составлена таким образом, чтобы по ней можно было оценить суть рассматриваемых в работе вопросов. В нее входят:
- Титульный лист (образцы см. здесь) - Реферат - Содержание (оглавление) (см. пример в Приложении 2) - Введение (1 - 3 стр.) 3.1. 2. Обзор литературы и постановка задачи (10 - 20 стр.) - Экономическая/научная потребность решения Вашей задачи.
- Научный/технологический/рыночный контекст.
- Технический и организационный контекст.
- Уточненные требования к работе.
3.1.3. Теоретическая часть (15 - 30 стр.) 3.1.4. Проектирование программного продукта (10 - 15 стр.) - Внешняя спецификация - Функциональная / проектная спецификация (-ции) 3.1.5. Реализация и применение программы (5 - 10 стр.) - Разработка программы - Тестирование и испытания программы - Примеры применения программы 3.1.6.. Охрана труда Этот раздел выполняется под руководством консультанта с кафедры «Охрана труда»
3.1.7. Заключение (1 - 2 стр.) 3.1.6. Литература (пример оформления списка литературы см. в Приложении 3) 3.1.7. Приложения - Руководство пользователя (2 - 3 стр.) - Распечатки / скриншоты результатов тестирования и применения - Исходные тексты модулей Примечание. Приведенная структура относится к типичной работе; в работах теоретического характера части 1 и 2 могут доминировать над остальными, но полное отсутствие частей 3 и 4 допускается только в исключительном случае чисто теоретической работы (что случается очень редко). Части 1 – 4 могут быть разбиты на произвольное число разделов и подразделов, название которых должно отражать существо работы. Разумеется, приведенная структура – не догма. Рассмотрение теоретических вопросов может перемежаться с практическими, если это способствует логической стройности изложения. Помните о структуризации: число разделов верхнего уровня (и подразделов раздела) не должно быть больше 5 - 7.
Комментарии.
Поясним требования к основным частям подробнее.
1) Обзор литературы выполняется затем, чтобы с одной стороны, "не изобретать велосипед", а с другой - "встать на плечи гигантам". Вам нужно показать место своей задачи на карте современной науки и технологии, показать достижимость цели и существующие ограничения, наметить пути решения. Кроме того, нужно описать систему, частью которой будет ваша программа (изолированных продуктов практически не бывает!). Обзор должен быть не простым пересказом источников, а их анализом с точки зрения Ваших проблем. Недопустимо копировать чужие тексты - помещать пространные цитаты; достаточно дать ссылку или короткую цитату. Используйте новейшую литературу: учебники, монографии, журнальные статьи, технические отчеты и описания. Результатом обзора должно быть подробное задание на разработку для решения непосредственно Вашей задачи.
2) В теоретической части явно отделяйте собственные результаты от известных.
Старайтесь привлекать новейшие формальные методы. Эта часть может быть шире, чем практическая часть - в том смысле, что не все ее результаты реализуются в программном продукте.
3) В 3 и 4 частях Вы описываете, как происходил переход от словесных и математических абстракций к программной реализации. В соответствии с принципами современной методологии программирования, этот переход должен иметь нисходящий характер, с пошаговой детализацией принимаемых решений.
4) Приложения содержат, прежде всего, программную документацию, без которой Вашим результатам - грош цена, так как использовать их можете только Вы, и никто другой.
Программа без документации имеет нулевую рыночную стоимость! Минимальный ее набор:
- Руководство пользователя, содержащее необходимые сведения об инсталляции, запуске программы и работе с ней, о сопряжении с другими программами, предостережения о неправильном использовании и т.д.;
- Исходные тексты модулей с достаточно подробными комментариями, необходимые для сопровождения и модификации Вашего продукта. (При большом их объеме достаточно распечатать только ключевые модули и заголовочные файлы.) Кроме того, в приложения выносятся распечатки результатов испытаний и примеров применения программы, подтверждающие ее работоспособность и полезность, а также части, композиционно "не вписывающиеся" в основной текст из-за своего большого объема (например, громоздкие доказательства и выводы формул).
В идеале, процесс написания текста диссертации должен быть совмещен с разработкой.
Чем раньше Вы начнете писать черновики, тем лучше. Неразумно в процессе разработки держать всю информацию в голове и только после завершения и теоретической, и практической частей садиться за чистый лист бумаги для написания текста. При правильной организации работы к моменту начала оформления результатов уже есть все необходимые фрагменты (аналитические модели, доказательства, схемы (диаграммы), псевдокоды, ссылки на литературу и пр.). Все это нужно объединить в логически стройное целое, добавив поясняющий текст. Рекомендуем писать этот текст путем пошаговой детализации - как последовательность все более подробных планов разделов, обсуждая их с руководителем.
Следует помнить, что главная цель работы - не коммерческая, а квалификационная:
диссертация должна давать представление в первую очередь о диссертанте, а не только о системе, модели, программе. Конечно, продукт труда тоже характеризует автора, но за итоговыми показателями не виден путь, которым они достигнуты. Ваша цель - показать, КАК Вы решали поставленную задачу, какими методами и средствами Вы владеете, сколько потов с Вас сошло, и какой Вы умный. Кстати, примерно тем же отличается хорошая научная публикация от отчета по НИР: в ней есть сведения, полезные для того, кто будет решать аналогичную задачу (какова сложность и трудоемкость решения, какие возможны подводные камни и т.д.); цель же отчета - убедить заказчика, что он получил то, что хотел и должен раскошелиться.
Итак, описывайте не только результат, но и процесс его достижения. Хвалите не свой продукт, а себя!
4. ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ РАБОТЫ
4.1. Общие замечания.1. Структура разделов - как это приведено в примере (Приложение 2). Введение и Заключение не нумеруются; у подразделов - составные номера (рекомендуется вложенность не более 3). Приложения нумеруются отдельно и должны иметь свои названия.
2. Рисунки могут занимать целую страницу или ее часть. Под рисунком помещается «Рис. № ». Рисунки, как и формулы, нумеруются в пределах раздела, номер которого служит префиксом (т.е., например, «Рис.1.5» означает пятый рисунок в первом разделе, «Рис. 2.1» - первый рисунок во втором разделе, и т.д.).
Подробнее см. ниже в п. 4.5.
3. Ссылки на литературу даются в квадратных скобках (например, [8], [1,7], [2 - 6]), нумеруются в порядке первого их упоминания в тексте. В разделе "Литература" в этом же порядке перечисляются источники с указанием автора, названия, издательства, года, страниц (пример дан в Приложении 3). Для источников из интернета нужно ссылаться на их URL и год публикации.
Не забудьте проверить орфографию. Неграмотность производит очень плохое впечатление. Избегайте «калек» с английского, если есть русские эквиваленты терминов.
Например, вместо антиалайзинг лучше писать устранение лестничного эффекта.
(знаком «+» отмечены обязательные, а знаком «Р» - рекомендуемые части) Структурные части Перечень условных сокращений выводы использованных источников 4.2. Исполнение текста 4.2.1. Средства графики Текст ТУД следует набирать на компьютере и печатать на принтере. Допускается машинописное и рукописное оформление. Цвет печати (письма) - черный, синий, фиолетовый. Не рекомендуется использовать цветную (красную, зеленую) печать текста.
4.2.2. Бумага, форматы и шрифты Бумагу выбирают в соответствии с техническими требованиями к принтеру. При рукописном оформлении применяют писчую бумагу. Для расчетных заданий и отчетов по лабораторным работам разрешается использовать тетрадные листы и другую бумагу.
Применяют форматы бумаги А4 (297х210) мм и А5 (148х210) мм. Для формата А рекомендуется шрифт "кегль 14" через 1,5 интервала, поля - по 20 мм. Для формата А рекомендуется шрифт "кегль 10" через 1 интервал, поля по 18 мм.
При рукописном оформлении необходимо выдерживать требования по размеру полей.
Таблицы и иллюстрации при необходимости можно изготовить на листах формата до A3 (297х420) и подшить в сложенном виде.
4.2.3. Исправления Описки и графические неточности в магистерских диссертациях, дипломных проектах, выпускных работах бакалавра, курсовых проектах и работах допускается исправлять подчисткой, закрашиванием белой краской или заклеиванием полосками белой бумаги с новым текстом. В остальных видах ТУД разрешается зачеркивать ошибочный текст.
4.3. Формулы Формулы предпочтительно вписывать средствами компьютерного текстового редактора (например, MathType). Допускается вписывание формул от руки. Формулы и уравнения, если к ним есть пояснения, следует выделять в тексте свободными строками. Пояснения значений символов приводят непосредственно под формулой в той же последовательности, в какой они даны в формуле. Пояснения начинают со слова "где" без двоеточия.
Например:
где S - площадь прямоугольника, м Формулы следует нумеровать арабскими цифрами в пределах раздела, если на них есть ссылки в последующем тексте. Номер формулы в круглых скобках помещают с правой стороны страницы на уровне формулы (см. пример выше - первая формула третьего раздела). Ссылки на формулы указывают порядковым номером в скобках, например:
"... в формуле (3.1)".
Перенос длинной формулы на другую строку делают после математических знаков.
При написании формул применяют обычные знаки препинания, например, разделяют запятыми несколько формул, написанных подряд, или ставят точку, если формулой заканчивается предложение.
4.4. Таблицы Таблицу размещают после первого упоминания в тексте так, чтобы ее было удобно читать без поворота ТУД или с поворотом по часовой стрелке. Таблицы нумеруют арабскими цифрами в пределах раздела. Над таблицей справа помещают слово "Таблица" с порядковым номером, например : "Таблица 1.2" (вторая таблица первого раздела). Если в ТУД таблица одна, ее не нумеруют и слово "таблица" не пишут.
При переносе таблицы на другой лист в его правом верхнем углу пишут слово "продолжение" и номер таблицы, например, "Продолжение табл. 1.2". Если в ТУД одна таблица, то при ее переносе пишут слово "Продолжение".
На все таблицы должны быть ссылки в тексте, например "... приведены в табл. 1.2".
Если таблица не имеет номера, при ссылке слово "таблица" пишут полностью.
Если все физические величины, приведенные в таблице, выражены в одних и тех же единицах, то обозначение единицы помещают в заголовке через запятую, например:
"Размеры изделий, мм".
Обозначение единицы физической величины, общей для всех данных в строке или графе, указывают в соответствующей строке боковика или в заголовке графы.
Не допускается делить заголовки таблицы по диагонали и включать графу "номер по порядку".
4.5. Рисунки 4.5.1. Нумерация Как правило, учебные тексты иллюстрируют графиками, диаграммами, схемами, чертежами, фотографиями. Все иллюстрации в ТУД называют рисунками. Рисунки нумеруют в пределах раздела, например: Рис. 2.3 (третий рисунок второго раздела). Если в ТУД содержится только один рисунок, то его не нумеруют. На каждый рисунок должна быть ссылка в тексте, например "приведено на рис. 2.3" или "... составим схему замещения (рис. 2.5)". При повторной ссылке на одну и ту же иллюстрацию указывают сокращенно слово "смотри", например: (см. рис. 2.3).
4.5.2. Техника исполнения Рисунки выполняют с помощью компьютера или от руки. В последнем случае используют карандаши, тушь, пасту или чернила темного цвета. Для большей наглядности рисунки выполняют цветными.
Рисунки могут быть расположены по тексту документа после первой ссылки на них или размещены на отдельных листах так, чтобы их было удобно рассматривать без поворота страницы или с поворотом по часовой стрелке. Для ТУД рекомендуется расположение рисунков на отдельных страницах (листах). Страницы (листы) с рисунками учитывают в общей нумерации. Рисунки небольшого размера помещают на странице по - 3 шт. Допускается оформление рисунков в формате до A3 (они подшиваются в ТУД в сложенном виде).
4.5.3 Состав рисунка Рисунки должны иметь номер и название и могут иметь поясняющие надписи.
Последние размещают выше номера и названия и ниже собственно рисунка (примеры оформления рисунков даны ниже).
Рис. 2.2. Временная диаграмма тока формирователя 4.5.4. Графики (диаграммы) Графики, выражающие качественные зависимости, изображают в прямоугольных координатах на плоскости, ограниченной осями координат без шкал значений величины.
Оси координат заканчивают стрелками, указывающими направление возрастании значений величин (рис. 2.2). Независимую переменную откладывают по горизонтальной оси (ось абсцисс). В полярной системе координат начало отсчета углов должно находиться на горизонтальной или вертикальной оси.
На графиках, выражающих количественные зависимости (экспериментальные или расчетные), должна быть координатная сетка (рис.2.3). При использовании клетчатой или миллиметровой бумаги сетку можно заменить делительными штрихами на осях. Стрелки на осях координат в этом случае ставить не принято. Цифры располагают ниже оси абсцисс и левее оси ординат, единицы измерения физических величин указывают по одной линии с цифрами. Обозначения переменных приводят по другую сторону оси.
Значения переменных откладывают в линейном или логарифмическом масштабах.
Переменные следует обозначать символом (см. рис. 2.2), математическим выражением (см. рис. 2.3) или словами. Последний вариант применяют, если переменная фигурирует в ТУД один раз, и введение для нее специального обозначения нецелесообразно.
При обозначении электрических величин для переменных величин желательно использовать строчные буквы, а для отдельных значений и для параметров цепей постоянного тока - прописные буквы.
На одной координатной сетке допустимо изображать две или более функциональных зависимостей, выделяя их линиями разных типов или различного цвета.
Характерные точки диаграмм допускается отмечать графически, например, кружками, крестиками и т.п. Обозначения точек должны быть разъяснены в пояснительной части диаграммы.
4.6. Написание обозначений единиц физических величин При написании числовых значений величин используют обозначения единиц буквами или специальными знаками, например:
Между последней цифрой числа и обозначением единицы физической величины следует оставлять пробел, исключение составляют знаки, поднятые над строкой. Не допускается перенос обозначения единиц на следующую строку.
Единицы, названные по именам выдающихся ученых, обозначают с большой буквы, например: В (Вольт), Гц (Герц), Па (Паскаль).
При указании значений величин с предельными отклонениями следует заключать их в скобки, например (125,0 + 0,1) кг.
Буквенные обозначения единиц, входящих в произведение, следует отделять точками на средней линии, например: Нм; Ам.
В буквенных обозначениях отношений единиц допускается только одна косая или горизонтальная черта, например: Вт/(мК). При использовании косой черты обозначение единиц в знаменателе следует заключать в скобки.
Десятичные кратные и дольные единицы образуют с помощью приставок, например:
кГц (килогерц), МВт (мегаватт), мкс (микросекунда).
Специфические приставки, связанные с двоичной системой счисления, используют в вычислительной технике. Наряду с основными единицами "бит" и "байт" употребляют единицы КБ (произносят "килобайт", эквивалентно 1024 байт) и МБ (произносят "мегабайт", эквивалентно 1048576 байт).
4.7. Сокращения Для снижения объема и трудоемкости исполнения ТУД в текстах применяют сокращения. Существуют общепринятые сокращения, например: КПД (коэффициент полезного действия), вуз (высшее учебное заведение), ГОСТ (государственный стандарт) и др. Применять общепринятые сокращения следует в соответствии с ГОСТ 7.12- "СИБИД. Сокращение русских слов и словосочетаний в библиографическом описании".
Развитие науки и техники постоянно порождает новые сокращения, некоторые из которых становится практически общепринятыми в определенной области знаний.
Например, в машиностроении: ЧПУ (числовое программное управление), САПР (система автоматизированного проектирования), ГПС (гибкая производственная система) и др. О возможности использования практически общепринятых сокращений автору ТУД следует проконсультироваться с преподавателем.
В конкретной ТУД бывает допускается введение своих сокращений.
При большом числе сокращений их включают в особый перечень.
Не допускаются следующие приемы сокращения текста: