По 2-му заданию (самостоятельное моделирование) составляется отчёт.
Отчет пишется на русском языке, предоставляется в электронном виде преподавателю (верстка в формат А4, "портрет", pdf или doc).
Отчет состоит из следующих частей:
• Титульный лист, с «шапкой» – «Московский государственный университет имени М. В. Ломоносова, факультет Вычислительной математики и кибернетики». Далее следует заголовок: «Отчёт по заданию №2», тема задания, сведения об исполнителе (фамилия, имя и отчество полностью, номер группы) и преподавателе, принимавшем задание. Внизу титульного листа указывается город и год. Нелишне обратить внимание на то, что точки после заголовков не ставятся.
• Содержание состоит из перечня названий глав и подглав, сопровождаемых указанием номеров страниц, с которых они начинаются. Нумеруются все страницы, за исключением титульного листа. Номер страницы с содержанием: 2.
• Первая глава, названная «Постановка задачи» содержит формулировку задания. Каждую главу следует начинать с новой страницы.
• Вторая глава, названная «Модель требований» содержит глоссарий, UML-диаграмму вариантов использования, описания действующих лиц и вариантов использования в соответствии с требованиями к заданию. Для одного из двух ключевых вариантов использования (и для каждого дополнительного ВИ, смоделированного для бонусных баллов) приводится UML-диаграмма деятельности. Здесь и далее подразумевается, что вёрстка отчёта (и составление диаграмм) должны быть выполнены так, чтобы каждая диаграмма помещалась внутри страницы, и при этом текст на диаграмме оставался разборчивым. Рекомендуется компоновать элементы на диаграммах довольно плотно, то есть, так, как это сделано в учебном пособии.
• Третья глава, названная «Модель анализа» содержит UML-диаграмму классов Key Abstractions, UML-диаграммы последовательности, описывающие взаимодействия между объектами в рамках потоков событий вариантов использования, UML-диаграммы классов VOPC. UML-диаграммы необходимо сопроводить пояснениями, указывающими, какому потоку событий они соответствуют (если это не ясно из их названия), и комментариями об объектах (классах), присутствующих на UML-диаграммах. Если UML-диаграмма последовательности не помещается на странице отчёта целиком, то следует разделить диаграмму на две части, и вторую часть смоделировать как отдельную диаграмму, на которую будет дана ссылка на первой диаграмме. Такая ссылка даётся как ref-фрагмент взаимодействия. Если двух частей-диаграмм не достаточно, то следует делить на три части и т. п..
• Четвертая глава, названная «Проектная модель архитектуры системы» содержит UML-диаграмму пакетов с указанием уровней системы, перечень пакетов и подсистем с указанием их назначения, UML-диаграммы пакетов для уровней, состоящих из более чем одного пакета. Также приводится UML-диаграмма размещения с пояснениями о каждом узле и компоненте на ней. Для встроенных систем (варианты со словом «терминал» и т. п.) UML-диаграмма размещения должна изображать связи между процессором и устройствами. В остальных вариантах UML-диаграмма размещения показывает узлы вычислительной среды, связи между ними и размещение процессов разрабатываемой системы по узлам.
• Пятая глава, названная «Проектная модель элементов системы» содержит описания проектных классов системы (всех ключевых абстракций и всех классов, участвующих в смоделированных реализациях ключевых вариантов использования), сгруппированных по пакетам. Сведения о классе включают в себя: краткое описание – ответственность класса; описание атрибутов и операций в виде таблицы из 2-х столбцов: полная сигнатура атрибута или операции, его или её назначение. Допускается не приводить описание тривиальных описаний как-то геттеров, сеттеров, конструкторов. Также приводятся UML-диаграммы проектных классов системы, отображающие связи между классами, одна нетривиальная диаграмма состояний, описывающая поведение экземпляров отдельного класса (как правило, класса-контроллера или класса-сущности), и одна диаграмма деятельности, моделирующая реализацию нетривиальной операции какого-то класса (т. е. такой, что в ней есть цикл и/или ветвление). Для одной смоделированной подсистемы приводится описание её интерфейса (полные сигнатуры операций и описания), диаграмма классов подсистемы (вид подсистемы изнутри) и диаграммы последовательности, описывающие реализации операций интерфейса подсистемы (достаточно описать 3-4 реализации разнородных операций, если в интерфейсе их больше). UML-диаграмма классов, моделирующая схему БД, также включается в эту главу. Если выполнялось моделирование реализаций дополнительных ВИ (дополнительной подсистемы), то сведения об этом могут быть включены в отчёт по усмотрению исполнителя задания. Если сведения будут включены, то могут быть начислены дополнительные баллы.
• Заключение (оно не нумеруется), в котором подводится общий итог работы, завершает отчёт. В заключении можно указать характеристики трудоёмкости созданной модели: количество вариантов использования; количество классов; количество UML-диаграмм разных видов.
|