Описание реализации программного продукта

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

В этом же разделе при необходимости можно привести алгоритмы некоторых методов.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выбор стратегии тестирования и отладка программного средства.

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

Отладка включает в себя поиск ошибки в тексте программного модуля (локализация ошибки) и исправление обнаруженной ошибки. Описывается проведённый анализ ошибок, выявленных в ходе написания, трансляции, тестирования и отладки программного средства. Приводятся распечатки экранных форм, отражающие полученные результаты решения поставленной задачи. Делается вывод о соответствии числовых значений результатов, их точности, форм выдачи и т.д. требованиям поставленной задачи. Можно привести данные статистической отчётности - количество допущенных ошибок (по видам), трудозатраты на разных этапах разработки и отладки модулей программного средства, расход вычислительных ресурсов на отдельных этапах выполнения задания. Описываются обнаруженные некорректные или нерациональные приёмы программирования и программные конструкции, ошибки в программе, ошибки в алгоритме и постановке задачи.

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

 

ПРАВИЛА ОФОРМЛЕНИЯ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

 

Оформление текстового материала

Пояснительная записка оформляется на листах формата А4. Графический материал можно оформлять на листах формата А3.

Для печати пояснительной записки используется шрифт Times New Roman размером 14 pt, выравнивание - по ширине страницы, с обязательным переносом слов. Шрифт, используемый в иллюстративном материале (таблицы, графики, диаграммы и т.п.), при необходимости может быть меньше, но не менее 10 pt.

Межстрочный интервал в основном тексте – полуторный. В иллюстративном материале межстрочный интервал может быть одинарным.

Поля страницы:

- левое поле – 25 мм,

- правое поле – 15 мм,

- верхнее и нижнее поле – 20 мм.

Отступ абзаца – 7,5 мм.

Нумерация страниц - сквозная.

Первая страница - титульный лист курсовой работы. Номер страницы на титульном листе не проставляется.

Вторая страница – содержание.

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

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

Разделы нумеруются арабскими цифрами (1,2,3). Слово "Раздел" не пишется. Подразделы нумеруются арабскими цифрами в пределах раздела (1.1, 1.2, 1.3, и т.п.). После цифры точка не ставится и пишется соответствующий заголовок. Точка в конце заголовков не ставится. Если заголовок включает несколько предложений, их разделяют точками. Переносы слов в заголовках не допускаются.

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

Записка завершается списком литературы.

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

 

Оформление рисунков, таблиц и формул

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

Каждый рисунок должен иметь подрисуночную подпись. Например:

Рисунок 2.1 – Форма окна основного меню

На все рисунки, таблицы и формулы в записке должны быть ссылки в виде: «(рисунок 2.1)» или «форма окна основного меню приведена на рисунке 2.1».

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

Если рисунок занимает более одной страницы, на всех страницах, кроме первой, проставляется номер рисунка и слово «Продолжение». Например:

Рисунок 12. Продолжение

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

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

Таблицы в тексте должны быть пронумерованы в пределах раздела. Ссылка на таблицу в тексте дается по ее номеру (например, "см. таблицу 1.1"). Над таблицей по центру листа помещается слово "Таблица", ее порядковый номер (2.1, 2.2, 2.3 и т.п.) и название. Точка в конце названия таблицы не ставится. После названия помещается сама таблица без пробельных строк. После таблицы перед тестом обязательное наличие пробельной строки.

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

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

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

Все помещаемые в текст формулы должны быть пронумерованы в пределах раздела, например, формулы (2.1), (2.2), (2.3) и т.д., где первая цифра обозначает номер главы, а вторая – номер формулы в пределах этой главы. Номер формулы проставляется в круглых скобках арабскими цифрами с правого края листа на уровне оси, проходящей через центр формулы. Сама формула должна быть отцентрирована относительно текста. Ссылки в тексте на соответствующую формулу даются также в круглых скобках, например "...расчет данных проводился по формуле (1.2)...".

 

Оформление текстов программ

Тексты программ должны оформляться в соответствии с «хорошим стилем» программирования, т.е. должны быть легко читаемы и хорошо документированы. В текстах должны быть комментарии. Однако комментарии не должны затенять структуру текста и должны быть ясными и краткими. Наименование программ и подпрограмм должны отражать их назначение. Логическая структура программы должна быть отражена в ее тексте с помощью:

1. пустых строк между текстами подпрограмм и отдельных ее функционально законченных частей;

2. сдвигами текста в строке при написании:

- заголовков вложенных циклов;

- тела цикла после его заголовка;

- альтернатив разветвлений процесса обработки данных.

 

Оформление списка литературы

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

Порядок указания источников следующий:

- законодательные акты;

- указы Президента, постановления Правительства РФ;

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

- учебники, монографии, диссертации и т.п.;

- статьи из периодических изданий;

- справочники;

- интернет-ресурсы.

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

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

Ссылка на источник в тексте работы приводится в квадратных скобках с указанием номера из списка литературы, например: "...в учебнике [2] дается такое определение...". Допускается также при ссылке на источник указывать соответствующую страницу издания, которая цитируется в работе: "...в учебнике [2, с.12] дается такое определение...".

Недопустимо заимствование текста из литературных источников без ссылки на автора цитаты.

Оформление приложений

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

Каждое приложение начинается с новой страницы. В верхнем правом углу страницы указывается слово "ПРИЛОЖЕНИЕ" и ставится его порядковый номер (например, "ПРИЛОЖЕНИЕ В"). Каждое приложение должно иметь заголовок, который ставится на следующей строке после слова "ПРИЛОЖЕНИЕ", и этот заголовок центруется относительно текста.

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

Если одно приложение содержит несколько рисунков, таблиц, формул, они должны быть пронумерованы в пределах этого приложения, например, "Рисунок А.3", "Таблица Б.2" и т.п. Остальные правила оформления иллюстративного материала в приложении такие же, как и для иллюстративного материала основного текста.

 

Оформление содержания

 

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

Заголовок (слово "СОДЕРЖАНИЕ") центрируется относительно текста. При проставлении страниц, соответствующих частям работы, может быть использована табуляция с заполнением.

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

 

 

ПРИЛОЖЕНИЕ А