Главная Обратная связь Поможем написать вашу работу!

Дисциплины:

Архитектура (936)
Биология (6393)
География (744)
История (25)
Компьютеры (1497)
Кулинария (2184)
Культура (3938)
Литература (5778)
Математика (5918)
Медицина (9278)
Механика (2776)
Образование (13883)
Политика (26404)
Правоведение (321)
Психология (56518)
Религия (1833)
Социология (23400)
Спорт (2350)
Строительство (17942)
Технология (5741)
Транспорт (14634)
Физика (1043)
Философия (440)
Финансы (17336)
Химия (4931)
Экология (6055)
Экономика (9200)
Электроника (7621)






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



 

Материал курсовой работы (проекта) должен быть изложен четко и логически последовательно.

Структура пояснительной записки к курсовой работе (проекту) должна иметь следующие обязательные элементы:

1. Титульный лист (см. Приложение А).

2. Лист задания на курсовую работу (проект) (см. Приложение Б).

3. Реферат.

4. Содержание.

5. Введение.

6. Основная часть в составе:

6.1. Техническое задание.

6.2. Описание используемого математического аппарата.

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

6.4. Руководство программиста.

7. Заключение.

8. Список использованных источников.

9. Приложение А Блок-схема программного продукта.

10. Приложение Б Исходные тексты программного продукта.

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

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

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

Введениесодержит обоснование выбора темы курсовой работы (проекта). В нем необходимо проработать следующие вопросы:

– состояние поставленной задачи (значимость и актуальность решения) на момент получения задания;

– цель разработки;

– область применения разрабатываемого программного продукта;



– авторское наименование программного продукта, которое соответствует заданию на курсовую работу (проект).

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

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

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

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

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



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

Третья глава называется «Руководство пользователя». Она состоит из следующих разделов:

1. Общие сведения (или «Введение»).

2. Требования к аппаратному и программному обеспечению (или «Системные требования»).

3. Установка программного продукта.

4. Использование программного продукта. Пользовательский интерфейс (или «Запуск и работа с программным продуктом»).

5. Удаление программного продукта.

6. Заключение (при необходимости).

Первый раздел содержит:

– краткое описание применения функциональных возможностей разработанного программного продукта;

– общие сведения о программном продукте, куда должны быть включены сведения об особенностях и специфике данного программного продукта, состав и описание программ, составляющих его структуру;

– назначение и область применения программного продукта.

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

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

– к типу, версии и составу операционной среды;

– к оборудованию и оснащению рабочего места;

– к режиму эксплуатации разработанного программного продукта.

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



Особенно важно перечислить полный перечень системных и вспомогательных компонент, необходимых для работы программного продукта с указанием точных версий и ссылок на их дистрибутивы в сети Интернет (в случае наличия их в свободном доступе). Нередко начинающие программисты забывают не только включить в дистрибутив программного продукта дополнительно необходимое программное обеспечение, но и указать его перечень (например, Run-Time библиотеки таких сред программирования, как Borland C++ Builder и Borland Delphi, Microsoft Visual Basic; пакет Microsoft .NET Framework; сторонние Active-X компоненты и так далее), из-за чего нарушается функционирование всей разработки.

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

Четвертый раздел «Использование программного обеспечения. Пользовательский интерфейс» является основным разделом руководства пользователя.

Он должен содержать подробные проиллюстрированные инструкции:

– по запуску программного продукта;

– по всем аспектам его настройки;

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

– по работе с входными и выходными данными, структуре и методам создания и корректировки информационной базы решаемой задачи;

– по подготовке к выходу из программного продукта и завершению работы с ним.

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

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

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

Четвертая глава пояснительной записки должна называться «Руководство программиста» (или «Программная реализация решения задачи»). Она содержит подробное описание алгоритмов разработанного программного продукта и состоит из следующих разделов:

1. Введение.

2. Общие сведения (или «Информация о проекте»).

3. Структура программного продукта.

4. Описание типов данных.

5. Описание исходных текстов программного продукта.

6. Результаты тестирования и опытной эксплуатации.

7. Заключение (при необходимости).

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

Второй раздел содержит следующую информацию:

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

– название, точная версия и состав всех использованных сред программирования, средств разработки приложений и баз данных (с указанием версий применяемых языков программирования);

– название, точная версия и состав всех использованных дополнительных и вспомогательных компонентов, утилит и программ.

Третий раздел должен содержать следующую информацию:

– перечень, структуру и краткое описание исходных текстов (файлов проекта) разработанного программного продукта;

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

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

В четвертом разделе приводятся все используемые в программном продукте типы данных с указанием их назначения, формата и точности представления, диапазона допустимых значений и порядка использования: константы, переменные, пользовательские типы данных, пользовательские структуры данных и так далее.

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

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

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

– ссылки на элементы блок-схем, соответствующие рассматриваемым элементам исходного текста;

– описание взаимосвязей и передачи управления между процедурами и функциями (обработчиками событий, исключений и так далее);

– описание взаимосвязей и передачи управления между модулями (формами).

Шестой раздел содержит доказательство надежности работы разработанного программного продукта.

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

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

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

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

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

«Список использованных источников» включает только те источники, которые использованы при выполнении курсовой работы (проекта). Источники располагаются в списке в порядке появления ссылок на них в работе (проекте).

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

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

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

Следует отметить, что программный продукт на основе графического пользовательского интерфейса, разработанный чаще всего с использованием RAD-систем (систем быстрой разработки приложений, например, Borland C++ Builder, Borland Delphi и так далее), нерационально изображать на одной блок-схеме. Фактически работа программного продукта состоит из вызовов нескольких обработчиков событий составляющих его объектов (например, визуальных компонентов пользовательского интерфейса), реализующих функциональность всего приложения.

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

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

В разделе «Приложение Б Исходные тексты программного продукта» приводятся фрагменты исходных текстов разработанного программного продукта, необходимые для понимания его функционирования.

Следует обратить внимание на то, что все исходные тексты в пояснительной записке не приводятся! Учитывая большие объемы исходных текстов современных программ и сравнительно небольшую их часть, написанную самими разработчиками (как правило, основную часть составляет исходный код, автоматически создаваемый средой программирования), имеет смысл привести только те фрагменты, которые действительно необходимы для понимания работы программного продукта. Все приведенные в Приложении Б фрагменты исходного текста должны быть снабжены комментариями и подробно рассмотрены в главе «Руководство программиста».

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

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

 


Просмотров 752

Эта страница нарушает авторские права




allrefrs.ru - 2021 год. Все права принадлежат их авторам!