4 Рекомендации по оформлению пояснительной записки и графического материала

Накануне защиты в ГЭК, в порядке, описанном в разделе 5, студентом представляются пояснительная записка (ПЗ) к дипломному проекту (ДП), техническое задание (ТЗ) на специальную часть и графический материал (чертежи и плакаты).

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

Техническое задание на специальную часть ДП бакалавра оформляется по соответствующему ГОСТу как отдельный документ, имеет автономную нумерацию страниц и подшивается в ПЗ после титульного листа и бланка задания на ДП. Например, если специальная часть ДП связана с разработкой программного обеспечения, то ТЗ оформляется в соответствии с ЕСПД [1].

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

К процедуре защиты в ГЭК необходимо подготовить электронную презентацию результатов проектирования, включив в неё: название ДП, постановку задачи; основные математические соотношения и модели; описания алгоритмов; схемы программных и аппаратных реализаций; числовые и графические результаты машинных и физических экспериментов; иллюстрации к разделам технико‑экономического обоснования, охраны труда и окружающей среды; общие выводы по ДП.

4.1 Общие требования к структуре, содержанию и объёму пз

Приведённые здесь рекомендации и требования по оформлению ПЗ основаны на материалах нормативных документов [2, 3].

Структурно в ПЗ выделяют вводную часть, основную часть и приложения. Обязательными элементами ПЗ являются: титульный лист; задание на работу; содержание; введение; основная часть работы; выводы (заключение).

При выполнении любого ДП разрабатывается техническое задание на специальную часть. ТЗ оформляется по правилам соответствующего ГОСТа (например, [1]) в виде отдельного документа с листом утверждения и титульным листом. ТЗ имеет свою автономную нумерацию страниц и подшивается в ПЗ перед листом "Содержание".

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

• титульный лист (специальный бланк) – первый лист ПЗ;

• Задание на проект (двусторонний специальный бланк) – второй лист ПЗ;

• ТЗ в виде отдельного документа с автономной нумерацией листов;

• Содержание ПЗ – третий лист ПЗ;

• Введение;

• основные разделы, отражающие существо ДП;

• Выводы;

• Перечень ссылок;

• Приложения (если они необходимы).

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

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

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

Основные разделы ПЗ содержат:

а) постановку задачи – даётся развёрнутая формулировка задачи, с максимальным использованием исходных данных по проекту, и характеристикой применения ожидаемых результатов проектирования. Обосновывается актуальность и практическая значимость задачи;

б) системный анализ задачи – обзор имеющихся в этом направлении разработок и критический их анализ с точки зрения заданных и выбранных исполнителем критериев;

в) разработку или выбор модели – в зависимости от ситуации и требований индивидуального задания, модель может быть аналитической, алгоритмической, имитационной или концептуальной;

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

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

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

ж) технико-экономическое обоснование проекта;

з) вопросы охраны труда и техники безопасности;

и) проблемы экологии и охраны окружающей среды, гражданской обороны.

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

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

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

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

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

Техническое задание (ТЗ) на проект должно содержать следующие обязательные разделы:

Введение.

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

2 Источники проекта.

3 Технические требования. Сюда входят, в свою очередь, подразделы:

3.1 Состав изделия и требования к конструктивному устройству.

3.2 Показатели назначения.

3.3 Требования надёжности.

3.4 Требования к программному обеспечению.

3.5 Требования по безопасности и эргономике.

3.6 Условия эксплуатации.

4 Экономические требования.

5 Порядок испытаний и тестирования.

6 Стадии разработки.

Пример ТЗ приведён в Приложении В.

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

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

Следует помнить, что ГЭК и рецензент не считают обоснованными решения декларативного характера типа: "Я так считаю" или "Так рекомендуется в книжке". При изложении обязательных требований следует применять слова "должен", "следует", "необходимо", "требуется, чтобы", "разрешается только", "не допускается", "запрещается", "не следует". Если для этих требований не приведены обоснования в настоящем документе, то следует указать ссылку на соответствующий библиографический источник, приведённый в Перечне ссылок ПЗ.

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

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

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

Полный объем ПЗ, включая приложения, должен быть в пределах 60 ÷ 100 листов формата А4.