Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
Методичка ДП 2012-2013.docx
Скачиваний:
0
Добавлен:
01.05.2025
Размер:
1.5 Mб
Скачать

– Оценку научно-технического уровня выполненного дипломного проекта в сравнении с лучшими достижениями в данной области.

Список использованных источников (ГОСТ 7.11-2004)

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

Источники располагают в алфавитном порядке и нумеруют арабскими цифрами.

Вначале перечисляются нормативно-правовые документы, затем – литература.

Графические материалы

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

Заключение

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

  1. Оформление дипломного проекта

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

– положение о дипломном проектировании Учреждения образования "Гомельский государственный машиностроительный колледж" от 15.11.2012;

– стандарта Учреждения образования "Гомельский государственный машиностроительный колледж" СТП УО ГГМК 1.01.00-2007;

– ГОСТ 7.32-2001 Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления;

– ГОСТ 2.105-95 Единая система конструкторской документации. Общие требования к текстовым документам;

– ГОСТ 7.11-2004 Система стандартов по информации, библиотечному и издательскому делу. Библиографическое описание документа

– ГОСТ 19.701-90 Единая система программной документации. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения

– нотации UML.

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

  • машинописным; текст печатается на одной стороне листа через 1 (один) интервал, шрифт 14, при числе страниц более 50 допускается в целях удобства использования в учебном процессе применять размер шрифта 12;

  • рукописным чертёжным шрифтом по ГОСТ 2.304 с высотой букв и цифр не менее 2,5 мм; следует писать чётко, чёрной пастой, тушью или чернилами;

  • машинным, с применением печатающих и графических устройств вывода ЭВМ. Текст печатается через один интервал, размер шрифта 14, при числе страниц более 50 допускается размер шрифта 12 Times New Roman Cyr.

Текст отчета следует печатать, соблюдая следующие размеры полей: правое — 10 мм, верхнее — 20 мм, левое и нижнее — 20 мм.

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

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

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

Подраздел – часть раздела, обозначенная номером и имеющая заголовок.

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

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

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

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

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

1 Типы и основные размеры

Нумерация пунктов первого раздела документа

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

Нумерация пунктов второго раздела документа

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

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

3.1 Аппараты, материалы и реактивы

Нумерация пунктов первого подраздела третьего раздела документа

3.2 Подготовка к испытанию

Нумерация пунктов второго подраздела третьего раздела документа

Если раздел или подраздел состоит из одного пункта, он также нумеруется.

Рисунок 2 – Пример оформления заголовков

Размер абзацного отступа 12,5мм.

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

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

Заголовки печатаются с интервалом 1 между несколькими строками одного заголовка. Расстояние между заголовками главы, пункта и подпункта – 2 интервала (8 мм – один <Enter>).

Расстояние между заголовком и текстом должно быть равно 3 или 4 интервалам (15 мм – один <Enter> при интервале 1,5).

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

Пример — Введение

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

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

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

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

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

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

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

Изложение текста документов

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

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

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

    1. В тексте не допускается:

применять обороты разговорной речи, профессионализмы;

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

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

применять сокращения слов, кроме установленных правилами русской ор­фографии, соответствующими государственными стандартами, а также в данном документе;

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

    1. В тексте документа, за исключением формул, таблиц и рисунков, не допускается:

применять математический знак минус (-) перед отрицательными значе­ниями величин (следует писать слово «минус»);

применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»). При указании размера или предельных отклонений диаметра на чер­тежах, помещённых в тексте документа, перед размерным числом следует писать знак «0»;

применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), > (больше или равно), < (меньше или равно),^ (не равно), а также значки № (номер), % (процент). В тексте следует писать словами «номер», «процент» и т. д.;

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

Знак № при нескольких числах не удваивать и ставить только один раз, до или после ряда чисел.

Пример — № 5, 6, 7, 8 и 9; или 5, 6, 7, 8 и 9 №.

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

Оформление формул

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

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

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

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

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

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

Например:

, (1)

. (2)

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

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

Оформление иллюстративного материала

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

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

Допускается нумеровать рисунки в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой, например – Рисунок 1.3 (третий рисунок первого раздела).

При ссылках на иллюстрации следует писать «… в соответствии с рисунком 2» при сквозной нумерации и «… как это видно на рисунке 1.2» при нумерации в пределах раздела.

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

Рисунок 3 – Схема расположение компонентов на форме

Оформление таблиц.

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

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

На все таблицы должны быть ссылки в отчете. При ссылке следует писать слово «таблица» с указанием ее номера.

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

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

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

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

Рисунок 4 – Пример оформления таблицы

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

Графу «Номер по порядку» в таблицу включать не допускается.

Допускается применять размер шрифта в таблице меньший, чем в тексте.

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

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

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

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

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

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

Более подробно требования к оформлению таблиц изложены в ГОСТ 2.105-95.

Оформление ссылок

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

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

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

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

Оформление приложений

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

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

Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «Приложение» и его обозначения. Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, Й, О, Ч, Ь, Ы, Ъ. Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и О. Если в документе одно приложение, оно обозначается

ПРИЛОЖЕНИЕ А

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

Приложение B.2.1

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

ПРИЛОЖЕНИЕ А

ТЕКСТ ПРОГРАММЫ

Иллюстрации и таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения, например – Рисунок А.3, Таблица Б.1.2.

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

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

Листинги программ также оформляются в виде приложений. Сам листинг должен содержать:

  • название программного модуля, заголовочный комментарий;

  • комментарии к функциональным блокам (функции и процедуры);

  • комментарии к логическим блокам;

  • комментарии к данным и структурам данных.

При оформлении листингов программ следует придерживаться определенных правил стиля программирования:

  • выбор идентификаторов должен нести смысловую нагрузку;

  • единый стиль для типов, для переменных;

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

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

Содержание графической части

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

  • алгоритмическую блок-схему задачи;

  • структурную схему алгоритма, программ, отдельных модулей;

  • схему данных;

  • схему программ;

  • схему работы системы;

  • схему взаимодействия программ;

  • схему ресурсов системы;

  • схему документооборота;

  • иерархию классов (плакат);

  • диаграмму классов;

  • диаграмму вариантов использования;

  • диаграмму деятельности.

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

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

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

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

Различают следующие виды схем (ГОСТ 19.701-90):

      • схемы данных;

      • схемы программ;

      • схемы работы системы;

      • схемы взаимодействия программ;

      • схемы ресурсов системы.

Описание схем

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

Схема данных состоит из:

      • символов данных (символы данных могут так же указывать вид носителя данных);

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

      • символов линий, указывающих потоки данных между процессами и носителями данных;

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

Символы данных предшествуют и следуют за символами процесса. Схема данных предшествует и следует за символами данных.

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

Схема программ состоит из:

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

      • линейных символов, указывающих поток управления;

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

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

Схема работы состоит из:

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

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

      • линейных символов, указывающих потоки данных между процессами и носителями данных, а также поток управления между процессами;

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

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

Схема взаимодействия программ состоит из:

      • символов данных, указывающих на наличие данных;

      • символов процесса, указывающих операции, которые следует выполнить над данными;

      • линейных символов, отображающих поток между процессами и данными, а также инициации процессов;

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

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

Схема ресурсов системы состоит из:

      • символов данных, отображающих входные, выходные и запоминающие устройства вычислительной машины;

      • символов процесса, отображающих процессы;

      • линейных символов, отображающих передачу данных между устройствами ввода-вывода и процессорами, а также передачу управления между процессорами;

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

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

Чертежи выполняют на листах бумаги определённого формата в соот­ветствии с ГОСТ 2.301, который устанавливает форматы листов чертежей и других документов, предусмотренных стандартами на конструкторскую документацию всех отраслей промышленности и строительства, основная надпись в которых выполняется по форме 1 ГОСТ 2.104.

Форматы листов определяются размерами внешней рамки (выполненной тонкой линией) оригиналов, подлинников, дубликатов, копий, в соответствии с рисунком 1.

Формат с размерами сторон 1189Х841 мм, площадь которого равна 1 м2, и другие форматы, полученные путём последовательного деления его на две равные части параллельно меньшей стороне соответствующего формата, принимаются за основные.

5

20

185

55

2 2 5

5 Внешняя рамка

Рисунок 5 – Формат размеров графической части

Основные надписи графических учебных документов должны соответствовать формам 1 и 2а ГОСТ 2.104–2006, при этом:

1 в графе 2 записывается обозначение документа в соответствии со стандартом учебного заведения;

2 в графе 4 записывается обозначение «У» – учебный;

3 в графе 9 заполняются две строки:

3.1 в первой строке указывается наименование учреждения образования. Для УО «Гомельский государственный машиностроительный колледж» аббревиатурой «ГГМК» и номер учебной группы (например: Пк42);

3.2 во второй строке записывается номер специальности или специализации в зависимости от принадлежности дисциплины, для которой разрабатывается документ;

3.3 остальные графы заполняются в соответствии с ГОСТ 2.104–68.

2

4

9

ДП 12345.02.00.000

Диаграмма вариантов использования

Литера

Масса

Масштаб

Изм

Лист

№ докум

Подп.

Дата

У

Лист 1

Лист 1

ГГМК; Пк-41

2-40 01 01 31

Рекомендации по разработке схем документооборота

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

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

Рисунок 6 – Пример схемы документооборота

Рекомендации по разработке диаграмм вариантов использования

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

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

  1. Определить главных (первичных) и второстепенных актеров.

  2. Определить цели главных актеров по отношению к системе.

  3. Сформулировать базовые (стратегические) варианты использования.

  4. Упорядочить варианты использования по степени убывания риска их реализации.

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

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

  7. Написать успешный сценарий выполнения выбранного варианта использования.

  8. Определить исключения (неуспех) в сценарии варианта использования.

  9. Написать сценарии для всех исключений.

  10. Выделить общие варианты использования и изобразить их взаимосвязи с базовыми со стереотипом <<include>>.

  11. Выделить варианты использования для исключений и изобразить их взаимосвязи с базовыми со стереотипом <<extend>>.

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

Рисунок 7 – Исходная диаграмма вариантов использования для примера разработки системы продажи товаров по каталогу

Рисунок 8 – Структурные элементы диаграммы вариантов использования

Рекомендации по построению диаграмм классов

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

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

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

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

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

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

Рисунок 9 – Пример диаграммы классов

Рекомендации по построению диаграммы последовательности

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

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

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

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

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

Линия жизни объекта (object lifeline) изображается пунктирной вертикальной линией, ассоциированной с единственным объектом на диаграмме последовательности. Линия жизни служит для обозначения периода времени, в течение которого объект существует в системе и, следовательно, может потенциально участвовать во всех ее взаимодействиях. Если объект существует в системе постоянно, то и его линия жизни должна продолжаться по всей плоскости диаграммы последовательности от самой верхней ее части до самой нижней.

Отдельные объекты, выполнив свою роль в системе, могут быть уничтожены, чтобы освободить занимаемые ими ресурсы. Для таких объектов линия жизни обрывается в момент его уничтожения. Для обозначения момента уничтожения объекта в языке UML используется специальный символ в форме латинской буквы «X». Ниже этого символа пунктирная линия не изображается, поскольку соответствующего объекта в системе уже нет, и этот объект должен быть исключен из всех последующих взаимодействий.

Рисунок 10 – Пример диаграммы последовательности

Сообщения бывают синхронными и асинхронными.

Синхронные сообщения приостанавливают поток выполнения до тех пор, пока не будет получен ответ.

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

Рисунок 11 – Пример диаграммы последовательности