Описание программного обеспечения




Требования к объему и детализации описания программного обеспечения зависят от задач и характера дипломной работы, от объема разрабатываемых программ. Программное обеспечение должно быть описано в соответствии с основными требованиями ГОСТов, составляющих Единую систему программной документации (ЕСПД). В реальной практике в ТЗ (техническое задание) включается раздел «Требования к программной документации», в котором определяется состав документов, передаваемых Заказчику вместе с программным обеспечением: например, «Руководство системного программиста», «Руководство оператора», «Программа и методика испытаний» и т.д. В документах имеются повторяющиеся разделы (например, «Назначение программы»), поэтому в дипломной работе нецелесообразно педантично воспроизводить форму этих документов. Достаточно продемонстрировать умение описывать программное обеспечение так, что из пунктов описания легко потом скомпоновать документы, определенные ТЗ. При наиболее полном описании разработанного программного обеспечения рекомендуем раскрыть в дипломной работе следующие пункты (они выбраны из ЕСПД).

1) Общие сведения о программе (программном комплексе - далее это уточнение будет опускаться).

Здесь указываются:

· обозначение и наименование программы;

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

· языки программирования, на которых написана программа;

· основные характеристики: объем и время работы программы.

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

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

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

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

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

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

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

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

6) Настройка программы (процедура инсталляции). Какие действия должен предпринять программист при установке программы на жесткий диск (например, если программа должна выполняться на IBM PC в операционной системе MS DOS, то возможно окажется необходимым добавить маршрут в файл autoexec.bat, задать нужные параметры в config.sys, создать рабочие каталоги и т.д.). Желательно описать командный файл, автоматизирующий процедуру инсталляции, сводящий ее к диалогу с программистом.

7) Эксплуатация программы.

7.1) Описание входных данных.

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

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

7.2) Описание выходных данных.

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

Сообщения об ошибках в выходную информацию не включаются.

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

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

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

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

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

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

9) Методика испытаний.

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

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

 

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

Заголовок (Фамилия И.О. индивидуальных авторов; наименование коллективного автора). Основное заглавие: Сведения, относящиеся к заглавию (раскрывают тематику, вид, жанр, назначение документа и т.д.) /Сведения об ответственности (содержит информацию о составителях, редакторах, переводчиках и т.п., об организациях, от имени которых опубликован документ). — Сведения об издании (содержат сведения о повторности издания, его переработке и т.п.). — Место издания: Издательство или издающая организация, дата издания. — Объем (сведения о количестве страниц, листов).

Если используется составная часть издания (например, статья в журнале или сборнике), то составляется аналитическое описание в следующем виде:

Сведения о составной части // Сведения о документе, в котором помещена составная часть.

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

 

Приведем примеры.

1) Описание книги:

Касаткин А.И. Профессиональное программирование на языке Си. Управление ресурсами: Справ.пособие. – Мн.: Выш.шк., 1992. – 432 с.

 

Место издания указывается сокращенно для следующих городов: Москва – М., Санкт-Петербург – СПб (Ленинград – Л.), Киев – К., Минск – Мн.

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

 

2) Описание статьи, входящей в книгу:

 

Хоор К. О структурной организации данных // Дал У., Дейкстра Э., Хоор К. Структурное программирование. – М.: Мир, 1975, С.98-197.

 

Указаны страницы, принадлежащие статье.

 

3) Описание статьи из журнала:

Иванов И.И. Поиски киберов // Доклады РАН. – 2005. – Т.2, № 4. – С.234-237.

или

Меффорд М. Клавиатура от A до Z // КомпьютерПресс. – 1991. – № 11. –С.29-39; № 11. –С.29-39.

 

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

Sidorov I.S. The axiomatic theory of relativity // Russian Math.Surv. – 1982. –V.37, N.2. – P.41-80.

 

4) Описание технического руководства:

Turbo Debugger. Version 2.5. User's Guide. Borland International. – [s.l.](USA),1991. – XIV pp.+428 pp.

 

В книге не указано место издания, поэтому в квадратных скобках добавляем информацию, не содержащуюся в издании. Для этого используются сокращения: без года – б.г. (т.е. не указан год издания), без места – б.м. (не указано место издания). В текстах, набранных латиницей, используются соответственно сокращения - s.a. (sine anno), s.l. (sine loco).

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

 

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

4. Состав графических материалов и правила оформления

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

Чертежи по формату, условным обозначениям, шифрам и масштабам должны строго соответствовать требованиям ЕСКД и ЕСПД. Чертежи могут выполняться на компьютере и распечатываться на плоттере или принтере или вручную. В последнем случае они, как правило, выполняются в карандаше, допускается выполнение чертежной тушью, но при этом все чертежи работы должны выполняться однотипно (или карандашом, или тушью). Если чертежи изготавливаются на принтере на бумаге размером А3 или А4, допускается их склеивание скотчем.

Формы, размеры, содержание, порядок заполнения основных надписей и дополнительных граф к ним в конструкторских документах устанавливает ГОСТ 2.104-68 ЕСКД (основные надписи). Примеры заполнения основных надписей на чертежах даны в «Курсовом и дипломном проектирование» О.Т.Даниловой (см. на диске Т).

Правила выполнения и оформления схем регламентируется ГОСТ. Виды и типы схем, общие требования к их выполнению должны соответствовать ГОСТ 2.701-84 «ЕСКД. Схемы. Виды и типы. Обще требования к выполнению». Правила выполнения всех типов электрических схем определяются ГОСТ 2.702-75 «ЕСКД. Правила выполнения электрических схем».

Выполнение электрических схем цифровой вычислительной техники осуществляется по ГОСТ 2.708-81. «ЕСКД, Правила выполнения электрических схем цифровой вычислительной техники» с учетом требований ГОСТ 2.701-84, ГОСТ 2.702-75, ГОСТ 2.721-74. Условные графические изображения (УГО) выполняются по ГОСТ 2.743-91 «ЕСКД. Обозначения условные графические в схемах. Элементы цифровой техники». Условные обозначения полупроводниковых приборов осуществляются по ГОСТ 2.730-73; обозначение резисторов и конденсаторов - по ГОСТ 2.728-74; обозначение устройств коммутаций и контактных соединений - по ГОСТ 2.755-87; буквенно-цифровые обозначения в электрических схемах - ГОСТ 2.710-81; интегральные оптоэлектронные элементы индикации - ГОСТ 2.764-86; элементы аналоговой техники - ГОСТ 2.759-82 запоминающие устройства - ГОСТ 2.765-87.

При выполнении схем, как правило, используются стандартные УГО. Если требуется применить не стандартизированные обозначения, то на схеме делаются соответствующие пояснения.

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

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

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

Схемы электрические структурные (Э1).

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

Схемы электрические функциональные (Э2).

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

Функциональные части изделия на схеме изображают в виде прямоугольников, а двоичные логические элементы - по ГОСТ 2.743-91. При выполнении функциональных электрических схем при дипломном проектировании рекомендуется использовать прямоугольники и указанные типы УГО, так как при таком исполнении схемы наиболее наглядно выявляются ее функциональные свойства.

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

Если схема выполняется с использованием УГО по ГОСТ 2.743-91, то рекомендуется применять координатный метод с разбиением поля чертежа координатной сеткой на отдельные зоны. Шаг координатной сетки по вертикали и горизонтали определяется габаритами минимального по размерам УГО на схеме. В основном поле УГО элемента указывается в первой строке условное обозначение функции, выполняемой элементом, во второй строке - координаты адреса УГО элемента (буквы и цифры) по левому верхнему углу УГО элемента.

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

Схемы электрические принципиальные (Э3).

Электрические принципиальные схемы выполняются в координатной сетке. Интегральные элементы цифровой вычислительной техники изображаются в виде УГО по ГОСТ 2. 743-91. УГО остальных электрических компонентов (транзисторов, резисторов, конденсаторов переключателей и т.д.) определяются соответствующими ГОСТ, указанными выше. Принципиальная электрическая схема выполняется после выбора конкретной элементной базы (серии или серий ИС). Каждый вывод УГО ИС имеет цифровое обозначение, соответствующее номеру вывода корпуса данной микросхемы. В самом общем виде УГО может содержать основное и два дополнительных поля. Размер прямоугольника по ширине зависит от наличия дополнительных полей и числа помещенных в них знаков; по высоте - от числа выводов и числа строк информации в основном и дополнительных полях. Согласно стандарту ширина основного поля должна быть не менее 10 мм, дополнительных - не менее 5 мм (при большом числе знаков в листах и обозначении функции элемента эти размеры соответственно увеличивают), расстояние между выводами - 5 мм, между выводами и горизонтальной стороной УГО - не менее 2,5 мм и кратно этой величине. ГОСТ разрешает поворачивать УГО по часовой стрелке на 90 град., при этом входы оказываются вверху, выходы - внизу. В основном поле УГО записывается следующая информация:

в первой строке - условное обозначение функции, выполняемой элементом;

во второй строке - обозначение элемента в серии ИС (например, ЛА7, если использованы ИС одной серии);

если в схеме применены ИС различных серий, то указывается и серия (например, К 155ЛА7);

в третьей строке - координатный адрес УГО на листе;

в четвертой строке указывается адрес данной ИС на ТЭЗе; если ТЭЗ не разрабатывался, то эта строка не заполняется.

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

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

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

Выполнение схем алгоритмов, программ, данных и систем.

Правила выполнения алгоритмов, программ, данных и систем автоматическим или ручным способом регламентируется ГОСТ 19.701-90. Применяемые УГО, отражающие основные операции процесса обработки данных, установлены ГОСТ 19.005-85 (Р-схемы алгоритмов и программ).

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

Линии потока информации разрешается разрывать при переходе к другим УГО, расположенным на других листах схемы, используя УГО «Межстрочный соединитель» или «Соединитель» с указанием внутри, к которому должна подойти линия потока информации.

Внутри УГО и рядом с ним делают записи и обозначения для уточнения выполняемых им функций. Присвоенные символы-идентификаторы (буквенно-цифровые обозначения) помещают слева над УГО. Адресация УГО на листе осуществляется в позиционной или координатной системе. Рекомендуется использовать координатную систему с применением координатной сетки для разбиения листа на зоны. Адреса в координатной системе или порядковые номера проставляют в верхней части УГО в разрыве его контура. При выполнении УГО приняты размеры по высоте h=10,15,20 мм и т.д. (размер кратен 5 мм по ширине b=1,5 h).

Выполнение чертежей конструкции изделия.

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

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

Сборочный чертеж при минимальном количестве проекций должен давать полное представление о всех элементах и деталях, их расположении и установке. В местах крепления установочных деталей (стоек, ТЭЗов, втулок, скоб) дают местные разрезы. Чертеж должен содержать технические требования на сборку.

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

5. Подготовка дипломной работы к защите

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

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

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

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

6. Защита дипломной работы

Утвержденная дипломная работы принимается к защите при представлении Государственной Аттестационной Комиссии (ГАК) следующих документов:

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

б) отзыва руководителя – 2 экз.;

в) отзыва консультанта – 2 экз.;

г) рецензии на дипломную работу – 2 экз.;

д) дипломная работа – 2 экз.;

г) компакт диск с текстом дипломной работы – 1 экз.

По желанию студента в ГАК могут быть представлены и другие документы и материалы, характеризующие научную и практическую ценность дипломного работы (например, макеты, справки о внедрении, авторские свидетельства и т.д.).

Указанные выше в пп. б-д) документы проходят норм-контроль на кафедре с целью проверки правильности оформления и сдаются заведующим кафедрой в деканат за два дня до первого назначенного дня для ознакомления с ними Председателя ГАК.

Защита дипломной работы на заседании ГАКа является публичной; дата и время защиты заранее сообщается деканатом. Защита состоит из доклада студента (не более 10 минут), ответов на вопросы членов ГАК, оглашения рецензии и отзыва руководителя и ответов студента на имеющиеся в них замечания.

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

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

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

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

Приложение А

 

 



Поделиться:




Поиск по сайту

©2015-2024 poisk-ru.ru
Все права принадлежать их авторам. Данный сайт не претендует на авторства, а предоставляет бесплатное использование.
Дата создания страницы: 2017-11-19 Нарушение авторских прав и Нарушение персональных данных


Поиск по сайту: