section 2 WIP

plan.md

@@ -0,0 +1,76 @@
+# План доклада курсовой работы
+
+!!! Акцент на хранение внутри, кодом (классы Python) может быть также важно, как и табличное представление.
+
+## Аннотация
+
+- краткое описание темы работы;
+- цель разработки диаграммера сетевой топологии
+  - !меняем на необходимость формализованного описания, смещаем акцент
+- итоговый результат: генерация YAML для развёртывания топологии в виртуальных машинах.
+  - !итоговый результат: модель данных. YAML-вывод только как пример
+
+## Оглавление
+
+- оглавление
+
+## Введение
+
+- актуальность автоматизации описания и развёртывания сетевых топологий;
+- проблема отсутствия удобных диаграммеров под заданные требования;
+  - !попытка обыграть - есть диаграммеры, но они не подходят для задания структуры
+- объект, предмет, цель и задачи работы.
+
+## Постановка задачи
+
+- формальное описание задачи построения топологии сети
+- требования к входным данным, диаграмме и выходному YAML
+  - !отсюда дейтсвительно важно лишь до какой степени описываем в таблице? Какие ожидания
+- всякие критерии?
+
+## Обзор
+
+- сравнение draw.io и аналогичных ему, нам не подходят
+- обзор существующих диаграммеров: D2, Graphviz, Mermaid и аналогов;
+  - !только как дополнение к модели
+- сравнение синтаксиса, Python-реализаций и применимости к сетевой топологии;
+- обзор подходов к построению схем по табличному представлению данных (ну тут просто ничего)
+- вывод - либо очень сложное, но формат в любом случае не подходит
+  - !а особенно для легкой воспроизводимости при лабораторных/на лекциях
+
+## Исследование и решение задачи
+
+- выделение сущностей предметной области: узлы, интерфейсы, связи
+- представление данных в виде таблицы
+  - !поля, что куда относится и за что отвечает, ограничения (или их отсутствие)
+  - !фактически это и есть разработанная модель
+- приведение к 1НФ и 3НФ
+- разработка модели и алгоритма преобразования таблиц в топологию yaml и диаграммы
+  - !здесь остаётся только диаграммы и yaml как пример применения модели.
+
+## Практическая часть, эксперимент
+
+- описание реализованного кода и архитектуры программы
+  - !первостепенно и дополнительно: табличное хранение, UML-график с внутренним хранением внутри питона
+- пример входных данных и построенной топологии
+  - !построенная топология снова только как показательный пример, что модель можно использовать
+- пример сгенерированного YAML
+- примеры на реальных лабах
+
+## Заключение
+
+- достигнутые цели и решённые задачи
+- практическая значимость
+- возможные направления дальнейшего развития.
+
+## Список литературы
+
+- источники по сетевым топологиям, нормализации, прочая штука
+- документация по всяким диаграммерам.
+
+## Приложения
+
+- фрагменты кода;
+- примеры таблиц в 1НФ и 3НФ;
+- UML-диаграмма классов в Python
+- примеры диаграмм и YAML-конфигураций на основе модели;