4.3.2 Документ "Пояснительная записка"

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

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

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

Типовая структура пояснительной записки и требования к содержанию и оформлению её структурных элементов приведены в [12, 13]. Соответствующие примеры, заимствованные из документации реально выполненных дипломных проектов и дипломных работ по специальности 230105, приведены в приложениях Б и В.

Главными структурными элементами пояснительной записки являются "Введение", "Основная часть" и "Заключение".

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

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

В соответствии с требованиями образовательного стандарта пояснительная записка должна содержать два специальных раздела, отражающих экономические и экологические аспекты разработки [14], выполняемой в составе дипломного проекта (работы). Требования к содержанию и объему специальных разделов определяют соответствующие консультанты, назначенные в установленном порядке.

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

4.3.3 Программная документация

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

• Документ "Спецификация" [5] содержит перечень компонентов программного комплекса и документации проекта, оформленный в табличной форме.

• Документ "Текст программы" [7] содержит исходные тексты программных модулей, написанные на соответствующих языках высокого уровня. Допускается представлять этот документ на машинном носителе.

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

• Документ "Программа и методика испытаний" [6] содержит описание процессов тестирования программной системы и проверки соответствия её характеристик требованиям, указанным в техническом задании.