From 26b40ef6b8956167f4c95482a520f1f82a420805 Mon Sep 17 00:00:00 2001
From: danielfeismann <daniel.feismann@tu-dortmund.de>
Date: Sun, 20 Jul 2025 14:25:42 +0200
Subject: [PATCH 1/2] Added 'PlantUML-Diagrams' as basis for documentation

---
 CHANGELOG.md                          |  1 +
 docs/uml/schematic_process.puml       | 37 +++++++++++++++++++++++++++
 docs/uml/schematic_process_short.puml | 31 ++++++++++++++++++++++
 3 files changed, 69 insertions(+)
 create mode 100644 docs/uml/schematic_process.puml
 create mode 100644 docs/uml/schematic_process_short.puml

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 26b0a45b..2a5ea913 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added ConfigFailFastSpec to properly test whether ConfigFailFast works as expected [#300](https://github.com/ie3-institute/MobilitySimulator/issues/300)
 - Implemented GitHub Actions Pipeline [#351](https://github.com/ie3-institute/MobilitySimulator/issues/351)
 - Added some infrastructure for GHA pipeline [#371](https://github.com/ie3-institute/MobilitySimulator/issues/371)
+- Added 'PlantUML-Diagrams' as basis for documentation [#382](https://github.com/ie3-institute/MobilitySimulator/issues/382) 
 
 ### Changed
 - Changed sets of evs from sorted to unsorted [#113](https://github.com/ie3-institute/MobilitySimulator/issues/113)
diff --git a/docs/uml/schematic_process.puml b/docs/uml/schematic_process.puml
new file mode 100644
index 00000000..5ebdbbac
--- /dev/null
+++ b/docs/uml/schematic_process.puml
@@ -0,0 +1,37 @@
+@startuml
+(*) --> "Initialise Simulation Parameter"
+if "Determine Type of Day" then
+    --> "Working Day"
+    --> "Load Day Type Parameters"
+else
+    --> "Saturday"
+
+    --> "Load Day Type Parameters"
+
+    --> "Initialise Trip Journal"
+
+    --> "Determine first Departure"
+
+    --> "Determine next Target State"
+
+    --> "Determine Driving Distance"
+
+    --> "Determine Driving Speed"
+
+    --> "Calculate Parking Duration"
+
+
+    if "Last trip of this day" then
+        [yes] if "All vehicles simulated?" then
+            --> [yes] (*)
+        else
+             --> [no]  "Initialise Trip Journal"
+                    endif
+    else
+     --> [no] "Determine next Target State"
+    endif
+
+else
+    --> "Sunday"
+    --> "Load Day Type Parameters"
+@enduml
\ No newline at end of file
diff --git a/docs/uml/schematic_process_short.puml b/docs/uml/schematic_process_short.puml
new file mode 100644
index 00000000..dfd38f06
--- /dev/null
+++ b/docs/uml/schematic_process_short.puml
@@ -0,0 +1,31 @@
+@startuml
+(*) --> "Initialise Simulation Parameter"
+if "Determine Type of Day" then
+    --> "Working Day"
+    --> "Load Day Type Parameters"
+else
+    --> "Saturday"
+
+    --> "Load Day Type Parameters"
+
+    --> "Initialise Trip Journal"
+
+    --> "Determine first Departure"
+
+    --> "Determine\n - next Target State\n - Driving Distance\n - Driving Speed\n - Parking Duration"
+
+
+    if "Last trip of this day" then
+        [yes] if "All vehicles simulated?" then
+            --> [yes] (*)
+        else
+             --> [no]  "Initialise Trip Journal"
+                    endif
+    else
+     --> [no] "Determine\n - next Target State\n - Driving Distance\n - Driving Speed\n - Parking Duration"
+    endif
+
+else
+    --> "Sunday"
+    --> "Load Day Type Parameters"
+@enduml
\ No newline at end of file

From d9810e97e4ae45b959e48e479e0ecd37a8d75df4 Mon Sep 17 00:00:00 2001
From: danielfeismann <daniel.feismann@tu-dortmund.de>
Date: Wed, 23 Jul 2025 13:39:02 +0200
Subject: [PATCH 2/2] add another puml version

---
 docs/uml/schematic_process_while_loop.puml | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 docs/uml/schematic_process_while_loop.puml

diff --git a/docs/uml/schematic_process_while_loop.puml b/docs/uml/schematic_process_while_loop.puml
new file mode 100644
index 00000000..a898c0eb
--- /dev/null
+++ b/docs/uml/schematic_process_while_loop.puml
@@ -0,0 +1,23 @@
+ @startuml
+start
+switch (Determine Type of Day)
+case ()
+  :Weekday;
+case ()
+  :Saturday;
+case ()
+  :Sunday;
+endswitch
+    :Load Day Type Parameters;
+    repeat
+    :Initialise Trip Journal;
+      :Determine first Departure;
+    repeat
+    :Determine next Target State\nDetermine Driving Distance\nDetermine Driving Speed\nDetermine next Departure\nCalculate Parking Duration;
+    :Simulate Trip and\nadd to Trip Journal;
+    repeat while (Next Departure today) is (yes) not (no)
+repeat while (All vehicles simulated?) is (no) not (yes)
+: Continue with next Day;
+stop
+@enduml
+