Оформление дипломных проектов

4.1 Общие требования к структуре и содержанию

Дипломный проект содержит:

· пояснительную записку;

· графическую часть;

· программный продукт (для дипломов с программированием).

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

Объем пояснительной записки не должен превышать 100-110 листов текста.

Титуль­ный лист подписывается студентом, руководителем дипломного про­екта, консультантами и заведующим кафедрой (Приложение 1).

Задание по дипломному проектированию подписывается руководителем дипломного проекта, студентом и утверждается заведующим кафедрой (Приложение 2).

Графическая часть представляет собой чертежи, схемы, диа­граммы, плакаты. В общем случае графическая часть раскрывает и до­полняет сущность проделанной работы. Объем графической части - не менее 6 листов формата А1.

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

4.2 Оформление пояснительной записки

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

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

Пояснительная записка к дипломному проекту выполняется на белорусском или русском языках. Текстовый материал оформляется в соответствии с действующими стандартами текстовых документов - ГОСТ 2.106-96 на белой бумаге формата А4, 210х297 мм, текст располагается с одной стороны.

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

компьютерный набор (шрифт - times new roman cyr, 12-14 пт, интервал - полуторный).

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

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

Содержание выполняется согласно приложению 3.

Текст пояснительной записки располагается внутри поля раз­мером 160х250 мм, соблюдая следующие размеры полей: левое - 25 мм, нижнее - 15 мм, правое - 10 мм, верхнее - 20 мм.

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

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

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

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

1 Постановка задачи

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

Каждый раздел следует начинать с нового листа. Расстояние между заголовком и текстом или с наименованием подраздела должно быть равно 3-4 интервалам.

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

В тексте нужно применять только одну систему единиц измерения СИ. Единица измерения одного и того же параметра должна быть постоянной, в пределах всего текста. Обоз­начение единиц измерения физических величин пишется без последу­ющей точки (например, М, Н), сложные единицы измерение записываются через ко­сую линию (например, м/с). Ин­тервалы величин в тексте записываются в виде "от" и "до" или че­рез многоточие (например, давление воздуха от 2 до 4 МПаили дав­ление воздуха 2... 4 МПа).

В текст пояснительной записки допускается вставлять рисун­ки, иллюстрации, распечатки экранных форм, фрагменты текстов про­грамм. Эти иллюстрации нумеруют арабскими цифрами в пределах всего текста. Номер рисунка (формулы, таб­лицы) должен состоять из номера раздела и порядкового номера рисунка, например, рисунок 2.8 (восьмой рисунок второго раздела). При ссылке на рисунок (формулу, таблиц) следует указывать полный номер, например,рис. 3.2. Повторные ссылки сле­дует давать с сокращением слова "смотри", например "см. рис. 1.2. Иллюстрации должны выполняться с использованием графических редакторов при компьютерном наборе или, в крайнем случае, черной тушью, чернилами или пастой, подчистки и помарки не допускаются.

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

Схемы алгоритмов и программ должны выполняться в соответст­вии с ГОСТ 19.701-90 и ГОСТ 19.005-85.

На все таблицы и иллю­страции в тексте должны быть ссылки, например: «...в таблице I», «...согласно рисунку 2».

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

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

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

Ссылки в тексте на порядковый номер формулы дают в скобках, например: "в формуле (2.15)".

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

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

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

В список использованной литературы включается только та литература, которая использовалась непосредственно при разработке проекта и на которую есть ссылка в тексте пояснительной записки. Источники следует располагать в алфавитном порядке по фамилиям ав­торов. Сведения о литературных источниках, включенных в список, необходимо давать в соответствии с требованиями ГОСТа 7.1-84.

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

с указанием номера ГОСТа (например, ГОСТ 2.106-68); на страницу текста – с указанием номера страницы (например, с.34) и т.п.

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

Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "Приложение" прописными буква­ми и иметь тематический заголовок, который записывают симметрич­но тексту прописными буквами. При наличии в документе более одного приложения все прило­жения нумеруются арабскими цифрами (без знака №), например: Прило­жение I.

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

Иллюстрации и таблицы в приложении нумеруются в пределах каж­дого приложения. На приложения должны быть даны ссылки в основном тексте документа. Все приложения должны быть перечислены в листе "Содержание".

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

Студенту предоставляется право по рекомендации кафедры представлять краткое содержание дипломного проекта на одном из иностранных языков, которое оглашается на защите и может сопрово­ждаться вопросами к студенту на этом языке.

4.3 Оформление графической части

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

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

Конструкторские документы обычно включают:

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

чертежи общих видов;

сборочные чертежи объекта и его узлов;

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

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

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

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

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

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

Графическая часть выполняется на ватмане формата А1. Над­писи выполняются согласно ГОСТ 2.304-81.

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

ГОСТ 19.701-90, ГОСТ 2.001-93, ГОСТ 19.005-85.

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

Полный перечень ГОСТов приведен в Приложении 4.

4.4 Оформление листингов

Листинги программ оформляются в виде приложений. Сам листинг должен содержать:

Заголовочный комментарий:

• название программного модуля;

• автор;

• условие выполнения;

• дата последней корректировки.

Комментарии к функциональным блокам (функции и процедуры):

• перед заголовком - назначение;

• после заголовка - описание входных и выходных параметров.

Комментарии к логическим блокам.

Комментарии к данным и структурам данных.

При оформлении листингов программ следует придерживаться определенных правил стиля программирования:

• выбор идентификаторов должен нести смысловую нагруз­ку;

• единый стиль для типов, для переменных;

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

Количество комментариев должно быть оптимальным и рас­крывать сущность выполняемых действий.

4.5 Кодирование дипломного проекта

Дипломный проект имеет код следующего вида:

ДП ХХХХХХ ХХХ XXХ ХХ

Первая группа знаков: ДП - дипломный проект

Вторая группа знаков: XXХХХХ - номер группы

Третья группа знаков: XXX - порядковый номер студента согласно приказу ректора БНТУ на дипломное проектирование

Четвертая группа знаков: код продукта (1 цифра) и две цифры - порядковый номер документа.

Код продукта:

1 - система

2 - функциональный блок

3 - элемент

4 – задача (исследовательская или математическая)

5 - программа (приложение)

6 – подпрограмма

Порядковый номер - 01 (если пояснительная записка в двух томах, то второй том будет иметь номер 02).

Пятая группа знаков: код части дипломного проекта - ПЗ - пояснительная записка или ГЧ - графическая часть