Документирование процесса разработки программных средств (стр. 1 )

Федеральное агентство по образованию

Государственное образовательное учреждение

высшего профессионального образования

Уфимский государственный авиационный технический университет

Документирование процесса разработки программных средств

Методические указания

к курсовому проекту по дисциплине

«Разработка и стандартизация программных средств и информационных технологий»

Уфа 2010

Федеральное агентство по образованию

Государственное образовательное учреждение

высшего профессионального образования

Уфимский государственный авиационный технический университет

Кафедра автоматизированных систем управления

Документирование процесса разработки программных средств

Методические указания

к курсовому проекту по дисциплине

«Разработка и стандартизация программных средств и информационных технологий»

Уфа 2010

Составитель:

УДК:

ББК :

Документирование разработки программных средств: Методические указания к курсовому проекту по дисциплине «Разработка и стандартизация программных средств и информационных технологий» / Уфимск. гос. авиац. техн. ун-т; Сост. . – Уфа, 2014. – 23 !Неопределенная закладка, NUMPAGESс.

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

Предназначены для студентов специальностей специальности 080801 – «Прикладная информатика (в экономике)» всех форм обучения

Ил.: 11. Табл.: 3. Библиогр.: 7 назв.

Рецензенты: канд. техн. наук, доц.

канд. техн. наук, доц.

© Уфимский государственный авиационный технический

университет, 2014

Содержание

стр.

1. Цель и задачи курсового проектирования. 4

2. Содержание курсового проекта. 4

2.1. Организация выполнения курсового проекта. 4

2.2. Содержание пояснительной записки. 5

3. Типовые задания на курсовую работу. 16

4. Указания к заданиям.. 19

5. Критерии оценки курсового проекта. 20

Библиография. 21

Основная литература. 21

Дополнительная литература. 21

2. Цель и задачи курсового проектирования

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

3. Содержание курсового проекта

3.1. Организация выполнения курсового проекта

Продолжительность выполнения курсового проекта – десять недель. Каждый студент вы­пол­няет индивидуальное задание, которое выдается ему преподавателем. Список типовых заданий на курсовой проект приведен в главе 3. Студент обязан посетить не менее 5 консультаций по вопросам выполнения курсового проекта, предъявляя на предварительный просмотр преподавателю отдельные результаты курсового проектирования или проект пояснительной записки. По результатам курсового проекта студентом в соответствии с требованиями, изложенными в параграфе 2.2, оформляется пояснительная записка и сдается преподавателю на проверку. Если все недочёты, выявленные при консультациях, устранены, студент защищает курсовую работу, по результатам защиты выставляется итоговая оценка. Если пояснительная записка не удовлетворяет поставленным требованиям, то она возвращается студенту на доработку.

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

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

2)  обоснование выбора языка программирования и СУБД;

3)  формирование структуры программного средства и алгоритма его работы;

4)  разработка таблиц реквизитов и экранных форм;

5)  определение тестовых наборов данных;

3.2. Содержание пояснительной записки

Пояснительная записка оформляется на листах формата А4 в соответствии с требованиями ЕСКД и должна содержать:

Титульный лист.

Введение.

Глава 1. Анализ предметной области проектирования.

Глава 2. Структура проектируемого программного средства.

Глава 3. Структура ввода-вывода программного средства.

Глава 4. Разработка тестовых наборов для программного средства.

Заключение.

Список литературы.

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

Между титульным листом и Введением следует подшивать задание на курсовое проектирование, полученное у преподавателя.

При нумерации параграфов каждой главы в номер следует включать номер главы. Например, для второго параграфа второй главы должен формироваться номер «2.2».

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

3.2.1. Постановка задачи

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

Содержание главы:

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

Пример 1:

Рис. 1 Пример таблицы входных, выходных и внутренних данных процесса

2)  Нормативные документы, устанавливающие требования к процессу.

Пример 2:

Налоговый кодекс РФ, кодекс РФ об административных правонарушениях, закон РФ «О защите прав потребителя», трудовой кодекс РФ, закон «О товарных знаках»;

3)  Участников процесса, структуру их подчинённости и описание основных функций, представляющие собой схему подчинённости и перечень функций участников.

Пример 3:

Рис. 2 Пример структуры участников процесса

Пример 4:

Начальник отдела снабжения выполняет следующие функции:

-  принятие решения о выборе поставщика;

-  администрирование работ отдела;

-  согласование договоров;

-  решение сложных вопросов с поставщиками.

Инженер отдела снабжения выполняет следующие функции:

-  обсуждение с поставщиками условий поставки;

-  организация согласования договоров на закупку;

-  контроль по целостности упаковок материалов при внешнем осмотре;

-  контроль за хранением материалов на складе.

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

Пример 5:

Рис. 3 Пример мнемосхемы выполнения процесса

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

Рекомендации по выполнению мнемосхемы:

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

-  мнемосхема должна отражать тему работы: если тема требует формировать отчёт, то он должен быть на мнемосхеме, если проверять исполнение, то необходима проверка или экспертиза и т. д.;

-  помните, что руководство должно быть на мнемосхеме выше своих подчинённых;

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

5)  Функциональная структура процесса, включающая иерархию функций процесса.

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

Пример 6:

Рис. 4 Пример фрагмента функциональной структуры процесса закупки материалов

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

Пример 7:

Анализ процесса показал, что важнейшими недостатками являются:

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

-  …

Для устранения недостатков предлагается автоматизировать следующие функции:

-  заполнение журнала отгрузок;

-  контроль исполнения заказов;

-  …

При этом необходимо создать следующие формы ввода:

-  ввод отгруженной продукции;

-  ввод потребителей;

-  …

И следующие отчётные формы:

-  …

Форм для ввода и шаблонов печатных форм должно быть не менее, чем по 3.

3.2.2. Проектирование программного средства

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

Содержание главы:

1)  Выбор и обоснование языка программирования

Пример 8:

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

Язык программирования	Вес критерия	Object Pascal	Visual C	Java
Дороговизна лицензии	3	3	2	1
Сложность освоения	2	…	…	…
Оптимальность кода	1
Функциональные возможности	2
…
Суммарный приоритет	…

2)  Описание языка программирования или среды разработки, включающее наименование языка (среды), основные особенности и причины выбора.

Пример 9:

Для автоматизации процесса снабжения использован язык программирования Visual Basic for Application, входящий в состав СУБД Microsoft Access, представляющий собой алгоритмический язык программирования, адаптированный под обработку сценариев. Выбор языка предопределил выбор СУБД. Язык представляет широкий набор инструментов по манипуляции данными, полностью интегрируясь с другими средствами Microsoft Access.

Пример 10:

Для выбора СУБД произведён выбор из следующих альтернатив:

Вид СУБД	Вес критерия	MySQL	Oracle	Interbase
Дороговизна лицензии	3	1	3	2
Сложность освоения	1	…	…	…
Аппаратные требования	3
Скорость работы	3
…
Суммарный приоритет	…

3)  Описание СУБД, содержащее наименование СУБД и причины её выбора.

Пример 11:

Для автоматизации процесса снабжения выбрана СУБД Microsoft Access 2003, которая позволяет создать персональную базу данных и недорогие приложения, работающие с ней. Выбор СУБД обусловлен её низкой ценой, лёгкостью освоения и достаточностью для решения поставленной задачи.

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

Пример 12:

Рис. 5 Пример структуры модулей

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

Пример 13:

Описание функций модулей программы:

Название модуля	Передаваемые данные	Получаемые данные
Модуль интерфейса	Запросы, сформированные пользователем	Отчёты базы данных
Команда на открытие формы расчёта	Форма расчёта
Команда на расчёт цены	Результат расчёта
Команда на закрытие формы расчёта	-
Модуль расчёта цены	…
…

Пример 14:

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

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

5)  Алгоритм работы программного средства представляет собой последовательность выполняемых программой команд. Алгоритм оформляется по ГОСТ 19.701-90. Следует использовать схему работы программы.

Пример 15:

Рис. 6 Пример фрагмента алгоритма

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

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

3.2.3. Визуальный интерфейс программного средства

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

Содержание главы:

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

Пример 16:

-  Ведомость материалов:

Название реквизита	Обозначение	Тип	Размерность
ФИО составителя	A_Name	Текст	50 симв.
Материал	Matirial	Текст	50 симв.
Срок хранения	CondData	Дата	8 симв.
…

Рис. 7 Пример фрагмента таблицы реквизитов входящего документа «ведомость материалов»