Структура пояснительной записки к курсовым проектам.
Введение. Здесь вы пишите, где, по вашему мнению, может быть использована ваша система, а также приводите структуру записки в описательной форме.
Глава 1.
Постановка задачи
1)Общая: берется из задания выданного преподавателем.
2)На вашу часть: описываете, что конкретно вы должны сделать в
рамках проекта.
Глава 2.
Проектирование. Здесь необходимо привести описание
назначения каждой из диаграмм со ссылками на литературу, а затем следующие диаграммы:
1)Use-case диаграмма реализованных вами функций (Use Case описывает сценарий взаимодействия участников (как правило — пользователя и системы). Участников может быть 2 и больше. Пользователем может выступать как человек, так и другая система.).
2) ER диграмма таблиц базы данных, которые вы проектировали (Если имеется БД).
3)UML-диаграмма разработанных вами классов с разделением на сущности, управляющие и граничные классы.
Глава 3.
Разработка 1) Описать используемые принципы ООП. В разделе обязательно ссылка на литературу, в которой описывается что такое программировании, какие у него есть принципы. Каждый из них приводится в общем виде и применительно к вашему проекту.
2)Описать обнаруженные типовые ошибки и их исправления или описания, как это можно было бы исправить и почему не исправили. То есть, поместить код с антипаттерном, а затем его исправленный вариант или как минимум объяснение, что вот тут мы его нашли, но исправить не хватило времени.
3)Используемые сторонние библиотеки для разработки с кратким их описанием.
4)Описание ваших этапов разработки с использованием системы контроля версий с приведением иллюстрации ее применения в виде скриншотов, каждый из которых поясняется.
5)Описание основных классов программы, разработанных вами.
Глава 4. Эксплуатация 1)Требуемое программное и аппаратное обеспечение для работы
вашего приложения.
2)Описание установки разработанного приложения.
3) Описание для пользователя: скриншоты и пояснения по работе с
каждой функцией программы.
Вывод. Необходимо написать, что было разработано, какие есть
достоинства, какие недостатки и какие перспективы развития данного проекта.