Сдача и приемка информационно-программного изделия.

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

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

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

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

По существу проекта члены комиссии задают вопросы и по совокупности ответов, качества документации и демонстрации проекта выставляют оценку.

4.4. Содержание программных документов.

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

При разработке курсового проекта могут быть использованы следующие программные документы:

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

Текст программы.

Описание программы.

Программа и методика испытаний.

Описание применения.

Руководство оператора.

 

Состав и структура основной части программного документа определяется соответствующими требованиями ГОСТ.

 

«Техническое задание» является основным документом, регламентирующим разработку программного изделия в рамках курсового проекта. Содержание документа "Техническое задание" устанавливается ГОСТ 19.201–94. Учитывая учебный характер курсового проекта, рекомендуется следующий состав технического задания на разработку программного изделия.

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

Основная часть программного документа “Техническое задание” состоит из следующих разделов:

1. Наименование.

2. Основание для разработки.

3. Исполнитель.

4. Назначение и цель разработки.

5. Содержание работы.

6. Этапы разработки.

7. Техническая документация, предъявляемая по окончании работы.

8. Порядок приема работы.

9. Дополнительные условия.

В разделе "Наименование" приводится полное наименование программного изделия и его шифр - сокращенное название или аббревиатура, или условное обозначение.

В разделе "Основание для разработки" указывается документ, на основании которого ведется разработка. Таким документом является задание на курсовой проект, подписанное руководителем курсового проекта. Здесь же указывается организация, утвердившая задание, - кафедра СОиУ МГТУ им. Н.Э.Баумана - и дата его утверждения.

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

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

5.1. Задачи, подлежащие решению.

5.2. Требования к программному изделию.

5.3. Требования к составу программных компонентов.

5.4. Требования к программным компонентам.

5.5. Требования к архитектуре программного изделия.

5.6. Требования к локальной базе данных.

5.7. Требования к входным и выходным данным.

5.8. Требования к временным характеристикам.

5.9. Требования к надежности.

5.10. Требования к составу технических средств.

5.11. Специальные требования.

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

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

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

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

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

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

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

В разделе "Этапы разработки" устанавливаются необходимые стадии разработки, этапы и содержание работ, а также сроки разработки. Содержание данного раздела должно быть увязано с календарным планом работы над курсовым проектом.

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

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

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

Лист утверждения технического задания оформляется в соответствии с ГОСТ 19.106–94. Лист утверждения подписывается студентом, осуществляющим разработку программного изделия, и преподавателем, являющимся руководителем курсового проекта.

 

«Текст программы» является основным документом для компонентов. Основная часть документа должна состоять из текстов одного или нескольких разделов (разделы могут быть объединены), которым даны наименования. Каждый из этих разделов реализуется одним из типов символической записи: символическая запись на исходном языке, на промежуточном языке, на языке машинных кодов и т.п. В символическую запись разделов необходимо включать комментарии, которые могут отражать функциональное назначение операторов программ или их групп, структуру программы и др. Эти комментарии также помогают освоить и понять содержание программного документа “Описание программы”. Отсутствие в тексте программы, разработанной в рамках курсового проекта, комментариев является недопустимым. В курсовом проекте текст программы если приводится, то на исходном языке программирования, оговоренном в техническом задании.

 

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

1. Общие сведения

2. Функциональное назначение

3. Описание логической структуры

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

5. Вызов и загрузка

6. Входные данные

7. Выходные данные

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

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

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

В разделе "Используемые технические средства" указывают типы электронных вычислительных машин и устройств, которые используются при работе программы.

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

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

Раздел "Выходные данные" содержит сведения о характере и организации выходных данных, формате и описании способа их кодирования.

 

«Программа и методика испытаний». Документ должен содержать следующие разделы.

1. Объект испытаний

2. Цель испытаний

3. Состав предъявляемой документации

4. Технические требования

5. Порядок проведения испытаний

6. Метод испытаний

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

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

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

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

«Описание применения». Текст основной части этого эксплуатационного документа должен состоять из следующих разделов.

1. Назначение программы

2. Условия применения

3. Описание задачи

4. Входные и выходные данные

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

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

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

В разделе "Описание задачи" должны быть указаны определения задачи и методы ее решения.

В разделе "Входные и выходные данные" приводят сведения о структуре и форматах входных и выходных данных.

 

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

1. Назначение программы

2. Условия выполнения программы

3. Выполнение программы

4. Сообщения оператору

В разделе "Назначение программы" указываются сведения, достаточные для понимания функций программы и ее эксплуатации.

В разделе "Условия выполнения программы" необходимо указать минимальный и (или) максимальный состав аппаратурных и программных средств, необходимых для выполнения программы.

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

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

 

Прочие документы.

Эти программные документы не являются обязательными согласно ГОСТ ЕСПД, но могут включаться в комплект технической документации, сопровождающей разработку.

 

 

5. Объем и оформление курсового проекта.

 

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

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

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

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

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

РПЗ должна быть оформлена опрятно, в соответствии с требованиями ГОСТ, не должна содержать орфографических ошибок. Уровень знания русского языка также оценивается при защите курсового проекта.

Графическая часть проекта может содержать различные виды конструкторской документации:

- схема структурная изделия,

- схема функциональной структуры,

- схема организационной структуры,

- схема структурная КТС,

- схема структуры данных, структуры объектов,

- схема алгоритма,

- схема программы (процедуры, подпрограммы, программного модуля, пакета прикладных программ),

- схема информационной (математической и т.д.) модели,

- схема прохождения и обработки информации,

- временные диаграммы,

- формы входных и выходных документов, формы и шаблоны экранных форм,

- теоретический чертеж,

- схема графа диалога,

- экспериментальные данные.

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

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

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

- варианты возможного проектного решения программного изделия,

- модульная структура изделия (объекты и процедуры),

- описание тестового примера, механизмов установки, настройки или инсталляции программного изделия.

Каждый плакат должен иметь основную надпись, расположенную вверху листа и две дополнительные надписи: ВЫПОЛНИЛ (подпись), УТВЕРДИЛ (подпись), расположенные в правом нижнем углу листа.

Графическая часть курсового проекта может быть выполнена на автоматизированном рабочем месте (АРМ) проектировщика с применением компьютерной графики, например VISIO.

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

Примерное распределение материала в графической части курсового проекта приведено из расчета 5 листов формата А1 на примере разработки программного компонента АСОИУ.

 

1. Общие сведения о разработанном ИПО АСОИУ.

Плакат.

2. Структурная схема ИПО АСОИУ.

Чертеж — Схема структурная.

3. Результаты проектирование баз данных.

Чертежи — Схемы моделей баз данных.

4. Математические алгоритмы обработки информации.

Чертеж — Схема алгоритма.

5. Граф диалога.

Чертеж — Граф диалога.

 

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

По содержанию на этом листе должно быть представлено:

- полное (расширенное) наименование изделия;

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

- взаимосвязи изделия со средой эксплуатации и пользователем, автоматизировать деятельность которого оно предназначено;

- таблица результатов сравнительного анализа аналогов и прототипов ИПО.

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

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

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