Проектирование и описание программного обеспечения

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

— техническое задание на разработку программного обеспечения;

— документацию на разработанный программный продукт.

3.4.1 Техническое задание разрабатывается на основе ГОСТ 19.201-78[12] и определяет содержание и требования, предъявляемые к программе. Оно разрабатывается студентом совместно с консультантом по специальной части и должно содержать следующие разделы:

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

— основания для разработки (для дипломных проектов — задание на дипломное проектирование, утвержденное заведующим кафедрой «Проблемы управления» МИРЭА);

— назначение разработки;

— требования к программе или программному изделию;

— требования к программной документации;

— технико-экономические показатели;

— стадии и этапы разработки;

— порядок контроля и приемки.

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

В разделе «Назначение разработки» должно быть указано функциональное и эксплуатационное назначение программы или программного изделия.

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

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

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

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

— требования к составу и параметрам технических средств (указывают необходимый состав технических средств с указанием их основных технических характеристик);

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

— требования к маркировке и упаковке носителей информации;

— требования к транспортированию и хранению программ;

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

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

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

— руководство пользователя;

— руководство программиста;

— перечень системных сообщений программы, …

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

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

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

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

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

— описание программы (по ГОСТ 19.402-78);

— руководство системного программиста (по ГОСТ 19.503-79);

— руководство программиста (по ГОСТ 19.504-79);

— руководство оператора (по ГОСТ 19.505-79).

В состав РПЗ включается также текст программы, который оформляется в соответствии с ГОСТ 19.401-78. Так как текст программы занимает много страниц, его целесообразно помещать в приложение (в отпечатанном виде, либо на компьютерном носителе информации).

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

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

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

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

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

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

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

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

— проверка (тестирование) программы (описываются способы проверки, позволяющие дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты));

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

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

— выходные данные (указываются характер и организация выходных данных; формат, описание и способ кодирования выходных данных);

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

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

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

Общие сведения:

— обозначение программы: SIN;

— наименование программы: программа вычисления значения функции sin (x);

— программное обеспечение, необходимое для функционирования программы: нет;

— язык программирования, на котором написана программа): ассемблер MSC-51.

— функциональное назначение: программа предназначена для вычисления значения функции sin (x) для аргумента, лежащего в диапазоне от 0º до 180º.

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

— контроллер KIT-552 на базе однокристальной ЭВМ 80C552PLCC,

— персональная ЭВМ на базе процессора Intel Pentium III, имеющая 256 Мб ОЗУ, накопитель на жестком диске емкостью 10 Гб, монитор VGA, клавиатуру, мышь, интерфейс RS-232 (для подключения KIT-552), операционную систему Windows XP, отладчик-симулятор некоторой фирмы, например Фитон (в данном случае используется только для написания и отладки программы SIN).

Структура программы. Вызываемых подпрограмм нет, но программа включает таблицу размером 360 байт, записанную в память программ. Она использует регистры с определенными именами, например A, R0, R1, R2, R3;

— алгоритм функционирования программы: (приводится рисунок с блок-схемой алгоритма программы и комментарий к нему).

Вызов и загрузка встроенных программ. При установке и настройке программы она записывается в память программ, например с адреса 0100h, а таблица — с адреса 1000h (при изменении стартовых адресов необходимо соответствующим образом в тексте программы изменить значения констант с используемыми именами, например PGM_ADDR и TBL_ADDR);

Пример вызова программы:

  mov a, #30                 ; запись значения аргумента (30)

                                       ; в аккумулятор

  call SIN                ; вызов подпрограммы

Входные и выходные данные:

— входные данные: значение формального параметра подпрограммы (аргумент функции sin) записывается в аккумулятор (если значение не выходит за допустимые границы, по окончании работы программы оно не изменяется, в противном случае аккумулятор становится равным FFh);

— выходные данные: значение вычисленной функции записывается в 16-разрядное слово (адрес которого совпадает с адресами регистров R0 и R1) в двоичном дополнительном коде (вещественному значению 1 соответствует значение слова 7FFFh). Сообщений нет.

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

Если программа предназначена для эксплуатации без ее изменения или встраивания в другой программный комплекс (то есть не является подпрограммой или составной частью библиотеки подпрограмм), то целесообразно руководство программиста (выполненное по ГОСТ 19.503-79 и ГОСТ 19.504-79) и руководство оператора (ГОСТ 19.505-79). Руководства следует выполнить в виде отдельных параграфов. В руководство оператора следует включить контрольный пример (тест или, так называемый прогон), выполнение которого позволит с одной стороны, проверить работоспособность программы и, с другой стороны, получить пользователю практические навыки работы с ней. В этом случае пояснительная записка может содержать шесть глав:

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

— глава 2 (техническое задание);

— глава 3 (руководство программиста);

— глава 4 (руководство оператора).

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

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

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

Следует избегать «пустых» комментариев:

mov A, #10h; Запись константы 10h в аккумулятор

call sin        ; Вызов подпрограммы

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

mov A, #10h; Запись значения аргумента функции sin

call sin        ; и вычисление ее значения

3.4.3 Особенности проектирования программ различного назначения. В дипломном проекте, посвященном разработке комплекса программ для работы с базами данных (БД) необходимо рассмотреть следующие вопросы:

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

— проектирование базы данных;

— решение функционально-прикладных задач из области мехатроники и робототехники с использованием БД;

— разработка демонстрационного примера.

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

Проектирование базы данных включает следующие этапы:

— анализ предметной области “Мехатроника и робототехника”, определение

— задач по проектированию БД и построение ее концептуальной модели;

— логическое проектирование БД;

— физическое проектирование БД.

Для построения концептуальной модели БД необходимо:

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

— выявить основные информационные объекты и связи между ними;

— построить информационную структуру предметной области и выполнить проектирование концептуальной модели БД.

В ходе логического проектирования БД необходимо:

— выбрать СУБД;

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

— выбрать ключи для прямого доступа к БД;

— описать язык запросов.

В ходе физического проектирования обычно определяют:

— структуру физических записей;

— распределение записей во внешней памяти;

— метод доступа.

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

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

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

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

В процессе проектирования БД требуется решить множество задач, в том числе:

— выбрать СУБД и язык, обеспечивающий своими средствами доступ к данным и действия над данными, а также определение структур данных, способов определения и интерпретации;

— сформировать структуру баз данных;

— подобрать подходящие имена таблицам и их полям;

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

— сформировать запросы для добавления, изменения и выборки необходимых данных, а также запросы для создания таблиц БД и др.

При решении задач целесообразно использовать средства, позволяющие разрабатывать схемы БД и приложения, работающие с БД. В качестве таковых могут быть использованы C++ Builder, Borland Delphi, Power Designer, Oracle Developer и др.

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

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

— разработка математического обеспечения задачи, описание математических моделей, численных методов и алгоритмов решения;

— разработка программного обеспечения комплекса;

— разработка демонстрационного примера.

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

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

— определение перечня программных модулей;

— обоснование входных/выходных структур данных для каждого модуля;

— выявление информационных связей между модулями;

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

— разработка текстов программ и их отладка;

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

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

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

— алгоритмы решения задач, проблемы их технической реализации;

— требования к системе команд микропроцессора (-в);

— требования к системному программному обеспечению;

— требования к прикладному программному обеспечению;

— алгоритмы взаимодействия между системным и прикладным обеспечением;

— распределение программ между ПЗУ и ОЗУ;

— язык программирования;

— средства отладки создаваемых приложений;

— вопросы, касающиеся оптимизации созданных программных средств;

— характеристики созданного программного обеспечения, их качество;

— результаты тестирования программ;

— рекомендации по применению, инструкция пользователю;

— инструкция программисту.

Примеры проектирования управляющих программ даны в [16].

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

— структурно-параметрическое описание объекта разработки;

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

— принципы построения систем информационного обеспечения процессов моделирования и (или) проектирования.

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

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

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

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

— принцип модульности, преемственности и открытости.

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

— назначение программы;

— рабочие структуры данных (при необходимости);

— HIPO-диаграмму;

— блок-схему алгоритма или описание алгоритма на псевдокоде.

В дипломном проекте, посвященном разработке виртуальных объектов (ВО) и пространств (ВП)необходимо представить:

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

— Созданную средствами компьютерной графики модель (-и) геометрического объекта (-ов), являющегося пространственным изображением физического образа реального объекта во внешней среде. Для этого рисование (визуализация) объекта и элементов внешней среды, их преобразования, освещение, построение и отображение теней, текстурирование, аннимация и другие технологии обычно реализуются с использованием алгоритмов трехмерной графики и соответствующих средств специализированных программ типа 3D MAX, а также библиотек типа OpenGL;

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

а) отладки программ управления роботом;

б) информационной поддержки управления по сети;

в) других применений.

Динамическую модель движения ВО, реализуемого средствами анимации илис помощью программ управления движением. 3D отображение движущегося ВО в ВП. Характеристику используемых регистров. Форматы данных и протоколы обмена данными. Интерфейс собственных программ ВО, пользовательский интерфейс оператора. Особенности взаимодействия ВО с периферийными устройствами через LPT и COM-порты. Режимы и условия использования объекта. Обоснование методических рекомендаций по применению ВО на основе данных экспериментальных исследований. Оценку возможных ограничений;

— Обоснование выбора операционной системы, в которой предполагается использовать виртуальную модель робота (иного объекта проектирования). Анализ интегрированных сред и средств разработки виртуального объекта, его компонент. Обоснование их выбора;

— Регламентацию во всем спектре функций созданного виртуального объекта в виртуальном пространстве условий его применения. Методические рекомендации по применению ВО и ВП. Иллюстрацию их возможностей с применением созданной демоверсии ВО и ВП.

Целесообразно также учесть опыт проектирования симуляторов, описанный в [17].