Требования к оформлению работы на электронном носителе




 

На электронном носителе все файлы курсовой работы должны быть расположены в одной папке. Имя папки, должно состоять из номера группы и фамилии студента, разделенных знаком «подчеркивание», например, студент группы 41101с Коробкин Сергей Дмитриевич должен назвать папку следующим образом: 1 41701с_КоробкинСД.

Электронный вариант курсовой работы представляется в формате RTF или Word 2003-2007. Имя файла, как и имя папки, должно состоять из номера группы и фамилии студента, разделенных знаком «подчеркивание», например, 1 41701с_КоробкинСД. doс или 1 41701с_КоробкинСД. rtf. Допускается титульный лист, задание на курсовую работу и реферат оформлять отдельным файлом, сохранив его под именем Титул_ КоробкинСД. doc в своей папке.

Приложения (тексты программных модулей) должны быть представлены в формате cpp, cs или java. Если в качестве приложений используются меню различного вида, то они должны быть отсканированы как графические объекты и сохранены в формате JPG. Файлы приложений должны иметь соответствующие имена, например, ПРИЛОЖЕНИЕ 1, ПРИЛОЖЕНИЕ 2 и т.д.

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

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

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

Обязательные компоненты, входящие в «Руководство пользователя»:

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

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

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

4. Назначение программного средства, где описываются назначение и область применения разработанного программного средства.

5. Условия применения программного средства, где приводятся требования:

- к конфигурации ПЭВМ, типу носителей данных;

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

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

- к режиму эксплуатации программного средства.

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

7. Инструкция по запуску и эксплуатации программного средства, где описываются:

- состав и содержание дистрибутивного носителя данных;

- инсталляция программного средства на ПЭВМ;

- порядок работы пользователя с данным программным средством.

8. Приложения, в которых приводятся:

- распечатка головного меню;

- образцы форм входной и выходной информации;

- иллюстрации, таблицы, графики, если есть.

2.5. Подготовка к защите и защита курсовой работ ы

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

Законченная курсовая работа, подписанная студентом, представляется руководителю.

Руководитель курсовой работы при оценке качества работы учитывает:

- степень решения поставленной задачи;

- степень самостоятельности и инициативности студента;

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

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

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

Схема программы

 

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

Схема программы должна чертиться согласно требованиям единой системы программной документации (ЕСПД), выраженным в виде ГОСТа 19.701-90, заменяющего и расширяющего ГОСТы 19.002–80 и 19.003–80. Основные новшества связаны с расширением набора символов (например, введен символ для обозначения передачи управления), изменениями значений некоторых символов (например, символа для обозначения оператора FOR) и исключением некоторых символов (например, символа магнитной ленты).

Основные моменты, на которые следует обратить внимание при работе

над схемой программы:

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

 

Рис.2.6.1. Стили изображения символов схемы программы

 

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

Изображение символа зависит от функции, которую он отображает. Все символы в пределах чертежа должны вписываться в одинаковые виртуальные квадраты с соотношением высота:ширина равным 2:3 и размерами 30х45 либо 40х60. Входящие, по отношению к символам, линии обычно подводятся только сверху, а исходящие – снизу или со сторон. Например, для приведенного выше символа условной вершины алгоритма один вход расположен сверху, а два выхода с надписями – слева, справа либо снизу в любой комбинации.

Символ должен содержать поясняющий текст в соответствии с функцией

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

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

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

3. Схема программы должна изображаться по координатной сетке. Высота ряда соответствует высоте символов схемы, а ширина колонки – их ширине. Таким образом, допустимые варианты: 30 и 45 мм либо 40 и 60 мм. Все символы вписываются в зоны координатной сетки. Координаты зон указываются для каждого из символов. Рекомендуется начинать схему в левой верхней части формата и продолжать ее вниз, а затем вправо. Линии связи рисуются по виртуальной пятимиллиметровой сетке, привязанной к основной.

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

5. Схема программы может содержать комментарии, которые наносятся особым образом. Комментарий изображается в виде особого символа – вертикальной (по возможности) «квадратной скобки». Символ комментария не привязывается к координатной сетке и, следовательно, не содержит координату. Символ комментария соединяется с комментируемым символом штриховой линией, не имеющей направления. Рекомендуется линию подводить к центру боковой стороны комментируемого символа и к центру внешней (обязательно) стороне квадратной скобки. Текст комментария должен наноситься с внутренней стороны квадратной скобки и выравнивается по ней. Размер квадратной скобки должен соответствовать размеру текста. Комментарий может относиться как к одному символу, так и к нескольким, возможно выделенным в особый блок штрихпунктирной линией. У одного символа может быть несколько комментариев. Рекомендуется помещать комментарии вблизи (слева или снизу) от тех символов, к которым они относятся.

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

 

Рис.2.6.2. Обозначение разрыва линии логической связи

 

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

7. Весь текст, содержащийся на схеме программы, должен быть нанесен одинаковым шрифтом одного размера. Рекомендуется использовать шрифт высотой 3,5 мм для символов с размерами 30х45 мм и 5 мм для символов с размерами 40х60 мм. «Подгонка» текста к размерам символов делается за счет изменения плотности, а не высоты шрифта.

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

9. Символы стандартных графических библиотек (например, Visio) могут не соответствовать отечественным ГОСТам и, следовательно, для обеспечения возможности их использования, должны быть скорректированы. Фрагмент примера схемы программы приведен в прил.7.

 

Схема данных

 

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

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

Диаграмма классов

 

В связи с отсутствием отечественных ГОСТов, регламентирующих правила оформления чертежей программного проекта с использованием объектно-ориентированного программирования, используется наиболее подходящий в такой ситуации стандарт унифицированного языка моделирования – Unified Modeling Language (UML), ныне поддерживаемый многими системами программирования, например, Rational Rose. Диаграмма классов (class diagram) является основным способом отображения иерархии объектов. Важным моментом является то, что такая диаграмма отражает лишь статические отношения между классами.

 

Основные моменты, на которые следует обратить внимание при работе

над диаграммой классов:

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

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

2. Атрибут (attribute) изображается в виде текстовой строки, отражающей различные его свойства:

<видимость><имя>:<тип>=<начальное_значение>{<свойства>}

 

3. Операция (operation) также изображается в виде текстовой строки:

 

<видимость><имя>(<список_параметров>):<тип_возвращаемого_\

значения>{<свойства>}

 

4. «Видимость» имеет обектно-ориентированную семантику:

– открытый атрибут или открытая операция (public) – обычно обозначается символом +;

– защищенный атрибут или защищенная операция (protected) – обычно обозначается символом #;

– закрытый атрибут или закрытая операция (private) – обычно обозначается символом –.

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

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

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

– отношение слияния (composition), т.е. «сильного» владения – один класс входит в другой класс по значению – обозначается обычной линией и залитой стрелкой-ромбом со стороны класса-владельца;

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

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

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

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

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

Более подробные сведения излагаются в стандарте UML.

Пример диаграммы классов (Visio) приведен в приложении 8.

 

ЛИТЕРАТУРА

1. Единая система конструкторской документации (ЕСКД): Справ. пособие /С.С. Борушек [и др.] – М.: Изд-во стандартов, 1989. – 352 с.

2. Единая система программной документации (ЕСПД).-М.: Изд-во стандартов, 1988. – 143 с.

3. Суша Н.В. Работы курсовые, выпускные и дипломные. Структура и правила оформления. СТП МИУ 2.0.01-05: Стандарт предприятия / Н.В.Суша [и др.] – Мн.: Изд-во МИУ, 2005. – 48 с.

4. Методические указания по дипломному проектированию для студентов специальности 40 02 01 «Вычислительные машины, системы и сети» всех форм обучения/ И.И. Глецевич, В.С. Комличенко, Ю.И. Тормышев – Мн.: БГУИР, 2002.– 82 с.

5. Методические указания по дипломному проектированию для студентов специальности 40 02 01 «Вычислительные машины, системы и сети» всех форм обучения/ И.И. Глецевич, В.А.Прытков, В.А. Отвагин – Мн.: БГУИР, 2007.– 103 с.

6. Библиотека ГОСТов [Электронный ресурс]. – Электронные данные.

– Режим доступа: https://gost.net.ru.

7. Тексты стандартов [Электронный ресурс]. – Электронные данные. – Режим доступа: https://stroyinf.ru/infr.html.

8. Архив ESPD.zip [Электронный ресурс]. – Электронные данные. –

Режим доступа: https://kladovka.net.ru/index.cgi?pid=list&rid=61.

9. От Visio 4.0 до Microsoft Visio 2002 [Электронный ресурс]. –

Электронные данные. – Режим доступа: https://www.visio.artberg.ru/.

Адреса в сети Internet

10. Комитет по стандартизации метрологии и сертификации при Совете

Министров Республики Беларусь (Госстандарт)

Адрес в Интернет: www.gosstandart.gov.by

E-mail: belst@belgim.belpak.minsk.by

11. Белорусский государственный институт стандартизации и сертификации (БелГИСС)

АдресвИнтернет: www.belgiss.org.by

E-mail: belgiss@mail.belpak.by

 

 

ПРИЛОЖЕНИЕ 1



Поделиться:




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

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


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