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

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

 

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

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

Объем пояснительной записки (без иллюстраций, таблиц, чертежей, графиков, листингов, приложений) должен быть около 60-80 страниц

Не следует искусственно увеличивать количество страниц в пояснительной записке за счет выбора большого размера шрифта (желательно не более 12-14), большого интервала между строками (желательно 1,5), больших отступов в начале абзацев (желательно не более 5 позиций), больших полей (желательно 2 см.).

 

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

Оформление и порядок представления материала в пояснительной записке в основном должны соответствовать [8].

 

Используемая терминология, условные буквенные обозначения механических, физических, математических и других величин должны соответствовать установленным ГОСТ’ам.

 

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

Текст пояснительной записки пишется на русском языке и все правила правописания и грамматики этого языка в записке должны соблюдаться. Не следует полагаться только на систему контроля правописания используемого текстового редактора.

 

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

 

Материалы пояснительной записки при ее брошюровании располагаются в следующем порядке:

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

2. Аннотация.

3. Задание на дипломный проект.

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

5. Основной текст пояснительной записки.

6. Список использованной литературы.

7. Приложения (если это необходимо).

 

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

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

 

Допускается оформление приложений в виде отдельно сброшюрованного альбома. Этот альбом должен иметь титульный лист с не­обходимой информацией:

- фамилия И.О. дипломника;

- тема дипломного проекта;

- номер приложения;

- название материала, входящего в приложение.

 

В аннотации проекта (объем до 1 страницы) кратко излагается содержание разделов пояснительной записки (например, "Раздел 2 посвящен выбору элементной базы проектируемой системы. С учетом требований к производительности системы выбран микроконтроллер типа ….").

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

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

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

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

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

Номера разделов, подразделов и пунктов даются без каких-либо дополнительных заголовков, например, "Глава", "Часть" и т.п. Подчеркивание заголовков не допускается. Точки в конце заголовков не ставятся. Заголовки могут выделяться шрифтом большего размера или полужирным шрифтом.

 

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

Иллюстрации, кроме таблиц, обозначаются словом "Рис." и нумеруются последовательно арабскими цифрами в пределах раздела. Номер иллюстрации должен состоять из номера раздела и порядкового номера иллюстрации, разделённых точкой. Например: Рис.1.2 – второй рисунок первого раздела. Все иллюстрации должны иметь подрисуночные подписи.

Нумерация таблиц проводится аналогично. Надпись "Таблица" и ее номер помещаются в правом верхнем углу таблицы. Над собственно таблицей помещается ее название.

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

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

 

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

Рекомендуется материал пояснительной записки делить на 4-5 разделов. Состав разделов зависит от направленности дипломного проекта.

 

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

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

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

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

 

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

 

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

 

Еще один раздел записки необходимо отвести под материалы, связанные с тестированием и отладкой разработанных программ. Раздел должен содержать описание выбора и обоснование использовавшихся тестов, результаты автономной отладки отдельных модулей и отладки всего комплекса программ, инструкции пользователю и т.п. При составлении этого раздела следует руководствоваться методикой, изложенной в [6]. Результаты отладки программ по возможности документированы представлением листингов или копий экранов.

 

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

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

- описание принципиальной схемы, анализ альтернативных вариантов решения, обоснование выбора элементной базы и режимов использования тех или иных элементов, особенно БИС, в схеме;

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

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

 

Список использованной литературы содержит перечень литературных источников (монографии, статьи, отчеты, препринты фирменные руководства, материалы из сети Internet и т.п.), которые были использованы при выполнении дипломного проекта и на которые сделаны ссылки в тексте записки. Список использованной литературы должен оформляться в соответствии с требованиями ГОСТ [9].

 

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

- алфавитное;

- хронологическое (по годам издания);

- тематическое (в списке выделяются самостоятельные рубрики, а внутри каждой рубрики расположение литературы проводится в алфавитном порядке);

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

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

При указании места издания допускаются следующие сокращения: для Москвы – М., для Ленинграда – Л., для Санкт-Петербурга – С-Пб. Названия остальных городов должны указываться полностью.

 

Оформление библиографического описания каждого источника может проводится на основе следующих примеров.

1. Книга одного автора:

Иванов И.И. Основы кибернетики. М.: Экономика, 1997. 344 с.

 

2. Книга двух авторов:

Иванов И.И., Петров П.П. Основы технической кибернетики. М.: Экономика, 1997. 544 с.

 

3. Книга трех авторов:

Иванов И.И., Петров П.П., Сидоров С.С. Словарь по технической кибернетике. М.: Экономика, 1997. 644 с. (Б-ка словарей "Экономика").

 

4. Книга четырех авторов:

Иванов И.И., Петров П.П., Сидоров С.С., Новиков Н.Н. Словарь по технической кибернетике. М.: Экономика, 1997. 644 с.

 

5. Книга пяти и более авторов:

Энциклопедический словарь по кибернетике / И.И. Иванов, П.П. Петров, С.С. Сидоров и др.М.: Экономика, 1997. 844 с.

 

6. Книга коллективного автора (конференция):

Международный симпозиум "Молодежь и наука" (14-18 мая 1998г., Дубна), Труды …: МиН-98. М.: Издат. ОИЯИ, 1998. Т.1. 608 с. (На обл. загл.: Молодежь и наука).

 

7. Книги под редакцией:

Информатика: Учебник для ВУЗов / Под ред. М.М. Макаровой. М.: Финансы и статистика, 1987. 456 с.

 

8. Сборник статей:

Защита информации в локальных сетях: Сб. ст. / Под ред. И.И. Иванова; Ин-т проблем управления. М.: Наука. 1997. 186 с.

 

9. Статьи из журнала:

Петров П.П. Методы построения автоматизированных обучающих систем // Монитор. 1997. № 4. С.17-19.

 

10. Информация, почерпнутая из Internet. При ссылке на источник в сети Internet необходимо указать сведения об авторах (если это возможно), название материала и его URL

 

Например,

John Crawford, Intel, and Jerry Huck, HP: Motivations and Design

Approach for the IA-64 64-Bit Instruction Set Architecture.

http://www.intel.com/pressroom/archive/speeches/mpf1097c.htm

 

или

Где делаются процессоры, ComputerWorld Russia, Февраль

1998, N3 http://www.osp.ru/cw/1998/03/business/05.htm

 

Подготовка доклада и иллюстративного материала для защиты дипломного проекта на Государственной экзаменационной комиссии.

Доклад дипломника на заседании ГЭК является основной формой ознакомления членов ГЭК с результатами выполненной за время дипломного проектирования работы. От качества его подготовки и выполнения во многом зависит итоговая оценка. Поэтому работе над докладом должно быть уделено самое пристальное внимание.

Время выступления не должно превышать 7-10 минут. Доклад может быть построен по следующей схеме.

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

- развернутая постановка задачи дипломного проектирования;

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

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

- сведения о практическом использовании полученных результатов;

- перспективы развития работы.

 

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

 

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

Иллюстративный материал в виде презентации рекомендуется выполнять с помощью программы Microsoft Power Point. Форматы презентаций *.ppt и *.pps универсальны для всех презентаций Power Point независимо от версии пакета Microsoft Office.

 

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

 

Проще всего с помощью PowerPoint можно иллюстрировать защиту диплома серией слайдов, последовательно сменяющих друг друга (линейная презентация).

Обязательными являются следующие слайды:

- титульный - должен содержать название темы дипломного проекта (выпускной работы) , ФИО студента и руководителя, место выполнения работы,

- постановка задачи;

- выбор метода решения;

- выводы.

 

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

Заключительный слайд: может повторять титульный с добавлением фразы "Спасибо за внимание!"

Презентация может состоять из 10-15 слайдов.