Структура пояснительной записки

Пояснительная записка к курсовому проекту является наиболее важной его частью и должна иметь объем порядка 30-40 страниц (с приложениями не более 60 страниц). Пояснительная записка должна соответствовать требованиям разделов 4 и 5 настоящих методических указаний. Пояснительная записка к курсовому проекту оформляется в соответствии с методическими указаниями по оформлению студенческих работ.

4.1 Типовая структура

Структура пояснительной записки должна соответствовать нижеприведенной в таблице 4.1 при использовании нотации Booch.

Таблица 4.1 – Структура пояснительной записки

Продолжение таблицы 4.1

При использовании нотации UML структура подразделов 3.1, 3.2, 3.3 изменяется: диаграммы Booch заменяются и дополняются соответствующими диаграммами UML.

Далее приведено примерное содержание типовой пояснительной записки. Структурные единицы «СОДЕРЖАНИЕ», «ПЕРЕЧЕНЬ ОБОЗНАЧЕНИЙ, СИМВОЛОВ, ЕДИНИЦ, СОКРАЩЕНИЙ И ТЕРМИНОВ» и «РЕФЕРАТ» в данных методических указаниях не рассматриваются (подробно см. методические указания по оформлению студенческих работ).

4.2 Титульный лист

Титульный лист оформляется в соответствии с требованиями, изложенными в методических указаниях по оформлению студенческих работ. При сдаче курсового проекта на проверку студент обязан поставить свою подпись и дату сдачи пояснительной записки. Если нормоконтроль проекта (т.е. проверку на соответствие имеющимся стандартам по оформлению) осуществляют не руководители работы, то дополнительно на титульный лист помимо блоков «Проверили» и «Выполнил» выносится блок «Нормоконтроль» с указанием должности и Ф.И.О. проверяющего. Пример титульного листа приведен в приложении Б.

4.3 Лист задания

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

В пункте «Исходные данные к проекту» указываются:

‒ разделы теоретической части, которые необходимо осветить в работе;

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

‒ перечень методов решения и т.д.

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

Пункт «Рекомендуемая литература» должен содержать список источников:

‒ по тематике курсового проекта;

‒ по программированию.

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

Пример оформления листа задания приведен в приложении В.

4.4 Раздел «Введение»

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

Во введении обязательно:

‒ обосновать актуальность выполнения курсового проектирования;

‒ указать объект и предмет разработки;

‒ сформулировать цель и задачи курсового проектирования.

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

4.5 Раздел «Постановка задачи»

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

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

Варианты предметных областей приведены в приложении А.

4.6 Раздел «Выбор метода решения»

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

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

4.7 Раздел «Метод решения»

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

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

4.8 Раздел «Выводы»

Обязательный раздел. Данный раздел не нумеруется.

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

4.9 Раздел «Перечень ссылок»

Обязательный раздел. Данный раздел не нумеруется.

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

4.10 Приложения

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

4.10.1 Техническое задание

Обязательное приложение.

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

Пункт «Общие сведения». Содержит информацию о раз­работчике, разрабатываемом продукте, сроках работы и норма­тивных документах, на основании которых выполняется работа.

Рекомендации к порядку и срокам выполнения кур­сового проекта были приведены в табл. 2.1.

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

Пункт «Требования к программному продукту» вклю­чает в себя:

‒ требования к ПП в целом;

‒ требования к задачам и функциям, выполняемым про­граммой;

‒ требования к техническому обеспечению (описание минимальной конфигурации ЭВМ, необходимой для нормального функционирования программного продукта);

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

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

Пример оформления технического задания приведен в приложении Ж.

4.10.2 Руководство пользователя

Обязательное приложение.

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

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

4.10.3 Экранные формы

Обязательное приложение.

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

4.10.4 Результаты работы программы (выходные файлы)

Необязательное приложение.

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

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

4.10.5 Листинг программы (листинги программных модулей)

Обязательное приложение.

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

Допускается использовать шрифты отличные от Times New Roman с целью улучшения визуального восприятия программного кода. Допускается распечатка листингов в две колонки, если при этом не нарушается читабельность программного кода (например, текст оператора разрывается на несколько строк).

Метод

В данном разделе методических указаний подробно, в соответствии с основными этапами выполнения курсового проектирования, излагается теоретический материал, а также доступно, на примерах, объясняется ОО методология разработки ПО. Все примеры данного раздела относятся к предметной области «Моделирование работы микроволновой печи», описание которой взято из [1] и приведено ниже.