Рекомендации по наполнению
При написании пояснительной записки основное внимание обратить на описание того что было сделано самостоятельно студентом по данному проекту. Не стоит сильно описывать всем известную теорию, а излагать в основном анализы, сравнения, факт, результаты.
Из пояснительной записки должно быть понятно, во-первых, какое конкретно программное обеспечение должно быть разработано в ходе дипломного проектирования с точки зрения функциональных возможностей для пользователя. Вопросы касательно требований к графическому дизайну интерфейсов не входят в компетенцию данной специальности. Во-вторых, на каком (их) языке(ах) разработано приложение, какие готовые фрэймворки или библиотеки использованы, а также какие сетевые архитектуры использованы. В-третьих, структура и объем программного кода, который дипломник разработал самостоятельно.
При описании предметной области желательно уделять внимание нормативно-правовым актам (НПА), которая используется в предметной области и по возможности реализовывать ограничения налагаемые НПА. В приложении желательно помещать, реальные бумажные формы и отчеты, которые используют на предприятиях и заполнение которых автоматизирует программное средство, как они выглядят в нормативно-правовых актах.
При описании существующих аналогов должны быть проанализированы обязательно аналоги как в мировом масштабе, так и в Республике Беларусь. Следует обратить внимание, что использование сокращения РБ в смысле Республика Беларусь в официальных документах не допускается.
Если подраздел имеет в названии слово «выбор» (выбор средств разработки, архитектуры и т.д.), то в содержании должно быть приведено два-три решения, определены критерии, приведена таблица сравнения по критериям и сделаны выводы о выборе того или иного средства. Если же в разделе просто перечисляются средства, использованные при разработке, то тогда раздел названии отдела нужно использовать термин «описание».
Описание средств разработки должно быть как можно кратким (ориентировочно 1 страница на средство). Так как это общеизвестный материал, а комиссию интересует то, что было разработано студентом. При описании средств разработки указывать информацию по существу, т.е. какие средства имеются в данном языке программирования, программном средстве для реализации функций программного средства. Не забывать описывать использованные фрэймворки, библиотеки и т.д., т.к. это может повлиять на оценку.
Поскольку работа выполняется на присвоение квалификации инженера, то разнообразные модели, схемы, архитектуры должны описываться не словесно, а с помощью соответствующих графических диаграмм. Рекомендуется использовать UML. Пример UML-диаграмм приведены в приложении Д.
Не путать разделы проектирование и руководство пользователя. В первом случае приводятся эскизные варианты интерфейсов, схема БД. Во втором случае помещаются экранные формы из уже работающей программы. Например, экранная форма, на которой приводится вид таблицы базы данной в СУБД – это не проект, а уже реализованная БД в данной СУБД. Пример описания БД приведен в приложении Е.
Если вводится раздел с названием тестирование программного обеспечения, то должна быть приведена полноценная информация о проделанном процессе тестирования: план испытаний, результаты испытаний.
Учитывая будущую квалификацию, из которой вытекает, что специалист будет заниматься внедрением и сопровождением программного обеспечения, то в описании работы с программным средством желательно привести инструкцию по установке, инструкцию по работе с программным средством, рекомендации по сопровождению программного обеспечения. Рекомендуется в данный раздел включить в экранные формы программного обеспечения в полном объеме с основополагающим функционалом, чтобы можно было получить представление о работе с программным средством, в случае если не удалось или нет возможности запустить программное обеспечение.
В приложениях обязательно должен присутствовать графический материал в виде чертежей и плакатов. На чертежах можно разместить UML-диаграммы, блок-схемы алгоритмов, схему базы данных, сетевые архитектуры. На плакатах – экранные формы, статистические данные, диаграммы, таблицы.
В приложение к пояснительной записке обязательно прилагаются фрагменты программного кода, которые реализуют существенные специфичные алгоритмы, компоненты системы и которые могут вызвать интерес и вопросы у членов комиссии.