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

Пояснительная записка на листах формата А4 по ГОСТ 2.301 к курсовой работе должна содержать следующие обязательные разделы:

— титульный лист (приложение А);

— задание на курсовое проектирование (приложение Б);

— реферат;

-содержание;

-введение;

-нормативные ссылки;

-основная часть:

1 Анализ технических требований и уточнение спецификаций

1.1 Анализ задания и выбор технологии, языка и среды разработки

1.2 Анализ процесса обработки информации и построение функциональных диаграмм

1.3 Анализ хранимой информации и выбор структур данных для ее представления

1.4 Выбор методов и алгоритмов решения задачи

2 Проектирование структуры и компонентов программного продукта

2.1 Разработка интерфейса пользователя

2.1.1 Разработка структурной схемы интерфейса

2.1.2 Построение графа (диаграммы) состояний интерфейса

2.1.3 Разработка форм ввода-вывода информации

2.2 Разработка алгоритма основной программы и структурной схемы программного продукта

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

2.2.2 Схема движения информационных потоков

2.3 Разработка основных алгоритмов программного продукта

3 Тестирование программы

3.1 Разработка плана тестирования

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

3.3 Оценка результатов тестирования

4 Сопровождение

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

4.2 Обслуживание модели, алгоритма, программы и их эксплуатация

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

-список использованных источников;

-приложения (листинг структуры файлов БД, листинг реализованных запросов, листинг компонент реализованных форм, отчетов, меню)

Пояснительная записка должна быть оформлена на листах формата А4, имеющих поля. Все листы следует сброшюровать и пронумеровать.

Содержание структурных элементов пояснительной записки

Пояснительная записка к курсовой работе пишется и оформляется согласно ГОСТ Р 1.5, МР КубГТУ 4.4.3 на протяжении всего выполнения курсовой работы. Наполнение разделов записки должно быть следующим.

«Реферат» должен содержать сведения об объеме, количестве иллюстраций, таблиц, приложений, количестве частей, количестве используемых источников, перечень ключевых слов, текст реферата оформляется согласно ГОСТ 7.9.

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

Текст реферата должен отражать объект исследования или разработки, цель работы, результаты, область применения. Пример реферата приведен в приложении В.

Раздел «Введение» (2, 3 страницы) включает краткое описание предметной области, цель реализации задания к курсовой работе, предполагаемые средства проектирования, результаты и их применение в предметной области. Во введении должны содержаться сведения о наименовании системы, поставлены и определены задачи курсовой работы, выделены актуальность и практическая значимость решаемой задачи.

Раздел «Нормативные ссылки» включает перечисление основных стандартов, используемых в курсовой работе.

Раздел «Анализ технических требований и уточнение спецификаций» начинают с подраздела «Анализ задания и выбор технологии, языка и среды разработки».В этом подразделе записки обосновывается и осуществляется выбор одной из современных технологий программирования. А затем поясняется выбор языка и среды разработки. При выборе технологии предпочтение следует отдавать объектно-ориентированному подходу как обеспечивающему максимальную эффективность разработки.

Далее определяются спецификации разрабатываемого программного обеспечения в виде одной или нескольких моделей:

— сценариев использования и диаграммы вариантов использования (рисунок 1);

— концептуальной диаграммы классов (рисунок 2);

— математических моделей;

— функциональных диаграмм (рисунок 3);

— моделей и структур представления данных и т. п.

Рисунок 1– Диаграмма вариантов использования

Рисунок 2– Концептуальная диаграмма классов

Рисунок 3–Функциональные диаграммы

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

При наличии сложно организованной информации необходим выбор структур для представления данных, который осуществляется на основе анализа основных процессов обработки данных (статические или динамические, массивы или другие структуры). При необходимости создаются новые структуры данных или модифицируются уже известные. Обычно при выборе структур учитываются следующие параметры: объем и типы данных, а также основные операции над данными (хранение, поиск, сортировка) и частота обращения к ним в процессе выполнения программы. Если возможны варианты, то производится их оценка по объему требуемой памяти и вычислительной сложности выполнения основных операций.

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

Рисунок 4– Экранная форма

Рисунок 5– Диаграмма состояний интерфейса

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

Рисунок 6– Иерархии меню

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

Рисунок 7- Диаграмма состояний формы интерфейса

(при событийном программировании)

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

Структурная схема – схема, отражающая состав и взаимодействие по управлению частей разрабатываемого продукта. При объектной декомпозиции такими частями являются объекты (рисунок 8), при структурной декомпозиции – подпрограммы (рисунок 9).

Рисунок 8– Структурная схема программного продукта

(объектная декомпозиция)

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

Рисунок 9– Структурная схема программного продукта

(процедурная декомпозиция)

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

Каждый алгоритм должен быть представлен:

— таблицей и списком используемых в нем глобальных переменных;

— схемой алгоритма, использующей имена переменных, приведенных в таблице или списке;

— описанием процесса обработки данных в соответствии с приведенной схемой алгоритма.

Рисунок 10– Алгоритм основной программы

(процедурное программирование)

Описание каждого алгоритма должно включать:

— функциональное назначение алгоритма;

— входные и выходные данные (результаты выполнения);

— список формальных параметров и их назначение;

— пример вызова модуля или подпрограммы;

— используемые технические средства;

— ссылку на таблицу переменных алгоритма;

— ссылку на рисунок со схемой алгоритма;

— описание процесса обработки данных в соответствии со схемой;

— если имеется приложение с полным текстом программы, то ссылку на соответствующую страницу приложения.

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

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

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

Рисунок 11– Диаграммы классов предметной области

Рисунок 12 – Интерфейсной части

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

Рисунок 13 — Диаграмма последовательности действий

В завершении раздела описывается декомпозиция разрабатываемой программы на модули и приводится диаграмма компоновки программного продукта (рисунок 14).

Рисунок 14– Диаграмма компоновки программного продукта

Кроме того, в этом же разделе желательно указать вариант разработки («восходящая» или «нисходящая») и обосновать свой выбор.

В разделе «Тестирование программы»выбираетсястратегия и методы тестирования. В соответствии с выбранной стратегией и методами строятся примеры тестов (обязательно с предполагаемыми результатами тестирования). Данные тестов рекомендуется представить в виде таблиц.

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

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

Список использованных источников выполняется по ГОСТ Р 7.0.5, ГОСТ 7.82 и данных методических указаний.