Разработка программы должна выполняться исключительно в соответствии с принципами объектно-ориентированного проектирования.
Содержание пояснительной записки должно отражать ход работы и наглядно демонстрировать результаты разработки.
Пояснительная записка начинается с титульного листа и листа с заданием, которые подшиваются в начале пояснительной записки.
Среди результатов разработки должны обязательно присутствовать:
А) техническое задание (в приложении к пояснительной записки) [2, 3];
Б) диаграмма классов и её описание;
В) схема алгоритмов (или диаграмма видов деятельности - UML) [4];
Г) руководство пользователя [5] (в приложении или отдельным разделов записки);
Д) методика тестирования или верификации программы (тестовые наборы для проверки корректного выполнения программой функций, определенных в техническом задании);
Е) исходные тексты программы с комментариями (в приложении к пояснительной записки).
По желанию исполнителя и согласованию с руководителем проекта в пояснительной записке могут быть приведены другие диаграммы, описанные в [3] или в спецификации языка UML.
Содержание пояснительной записки следует разделить на разделы и подразделы; разделы должны иметь порядковые номера, обозначенные арабскими цифрами. Подразделы должны иметь порядковые номера в пределах каждого раздела. Каждый раздел должен начинаться с нового листа, а каждый пункт записывается с абзаца. Наименование раздела записывается в виде заголовков прописными буквами, а подразделов - строчными (кроме первой прописной). Точку в конце заголовка не ставят.
Текст записки следует печатать, соблюдая следующие размеры полей: верхнее, левое и нижнее – 20 мм, правое – 10 мм.
Для текста используется шрифт Times New Roman, 14.
Междустрочный интервал составляет один интервал. Отступ абзаца составляет 1 см. Текст в абзаце должен быть выровнен по ширине.
Оформление пояснительной записки выполняется согласно положениям учебного пособия [1], а также стандартов ЕСПД (единой системы программной документации) [2, 4, 5].
Пояснительная записка к курсовому проекту, в общем, может включать в себя следующие разделы (названия глав и параграфов могут отличаться от приведенных ниже):
Содержание
Введение
1. Постановка задачи
2. Формулирование и анализ требований к программе
2.1. Анализ предметной области
2.2. Разработка требований к обработке информации
Выводы
3. Проектирование программы
3.1. Выбор структур данных для хранения информации
3.2. Разработка алгоритмов работы
Выводы
4. Реализация программы
4.1. Выбор языка программирования и среды разработки
4.2. Структура программного обеспечения
4.2. Проектирование пользовательского интерфейса
4.2. Описание классов, методов (функций) и модулей
4.3. Тестирование приложения на ЭВМ
Выводы
Заключение
Перечень ссылок
Приложение А. Техническое задание
Приложение Б. Текст программы
Приложение В. Руководство пользователя
Приложение Г. Презентация
В разделе "Введение" необходимо определить и дать краткую характеристику предметной области, для которой разрабатывается программа. Т.е. описать её назначение (например, если программа реализует работу стека, то нужно объяснить что представляет собой стек и чем он отличается от других структур данных, какие операции стек поддерживает и какие ошибки возможны при выполнении этих операций). В ходе проектирования рекомендуется использовать методическую литературу [8, 9, 10, 11, 12], имеющуюся в электронном варианте.
В разделе "Постановка задачи" необходимо описать, как и для чего с точки зрения пользователя должна использоваться будущая программа.
В разделе "Разработка требований " необходимо систематизировать требования и выделить:
А) перечень основных функций (входные и выходные данные, описание способов получения выходных данных из входных);
Б) требования к техническим средствам (аппаратные ограничения);
В) требования к сервисным средствам;
Г) требования к пользовательскому интерфейсу.
Подробно процесс разработки требований описан в методическом руководстве [3]. Если в ходе формулирования и анализа требований было разработано полноценное техническое задание, его целесообразно вынести в приложение. В выводах по данному разделу нужно кратко описать полученные результаты и отметить имеющиеся проблемы и ограничения, выявленные при анализе требований.
В разделе "Проектирование программы" необходимо описать стандартные структуры данных (массивы, указатели и т.д.), которые Вы считаете наиболее удобными для хранения данных Вашей программы. Описать и изобразить в виде схем алгоритмы выполнения основных функций. В выводах по разделу нужно подвести итоги по принятым проектным решениям и определить ограничения, способные повлиять на выбор языков программирования и средств разработки.
В разделе "Реализация программы" необходимо описать весь процесс программирования и тестирования программы. При этом порядок и изложение материала и содержание раздела могут отличаться от приведенного в примере, но изложение материала рекомендуется делать в соответствии с требованиями стандартов ЕСПД [4, 5].
В "Заключении" необходимо описать всю проделанную работу и отметить возникшие при разработке проблемы (нереализованные функции, неисправленные ошибки и т.д.), а также возможные пути улучшения программы.
"Перечень ссылок" должен быть оформлен в соответствии с требованиями стандартов [6-7].
