added structure for engine

ProjektAdLer · Mar 4, 2024 · 7998676 · 7998676
1 parent ed43864
commit 7998676
Show file tree

Hide file tree

Showing 31 changed files with 254 additions and 4 deletions.
diff --git a/AdLerDokumentation/Writerside/hi.tree b/AdLerDokumentation/Writerside/hi.tree
@@ -45,9 +45,38 @@
             <toc-element topic="Software-Design-Generator.md"/>
         </toc-element>
         <toc-element topic="Engine-BG.md">
-            <toc-element topic="Funktionale-Anforderungen-Engine.md"/>
+            <toc-element topic="Funktionale-Anforderungen-Engine.md">
+                <toc-element topic="Hilemenü-FunktionaleAnforderungen-Engine.md"/>
+                <toc-element topic="InternetVerlust-FunktionaleAnforderungen-Engine.md"/>
+                <toc-element topic="Ladebildschirm-FunktionaleAnforderungen-Engine.md"/>
+                <toc-element topic="Startmenü-FunktionaleAnforderungen-Engine.md"/>
+                <toc-element topic="Lernweltmenü-FunktionaleAnforderungen-Engine.md"/>
+                <toc-element topic="Lernraummenü-FunktionaleAnforderungen-Engine.md"/>
+                <toc-element topic="Lernraum-FunktionaleAnforderungen-Engine.md">
+                    <toc-element topic="3D-Lernraum-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Adaptivitätselement-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Storyelement-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Menüleiste-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Lernziele-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Lernfortschritt-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Türen-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Lernelemente-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Avatar-FunktionaleAnforderungen-Engine.md"/>
+                    <toc-element topic="Pausenhinweise.md">
+                        <toc-element topic="EKJ0001.md"/>
+                        <toc-element topic="EKJ0002.md"/>
+                        <toc-element topic="EKJ0003.md"/>
+                        <toc-element topic="EKJ0005.md"/>
+                    </toc-element>
+                </toc-element>
+            </toc-element>
             <toc-element topic="Nicht-funktionale-Anforderungen-Engine.md">
-                <toc-element topic="GUI-Engine.md"/>
+                <toc-element topic="GUI-Engine.md">
+                    <toc-element topic="GUI-Engine-Startseite.md"/>
+                    <toc-element topic="GUI-Engine-Lernweltmenü.md"/>
+                    <toc-element topic="GUI-Engine-Lernraummenü.md"/>
+                    <toc-element topic="Engine-GUI-3D-Lernraum.md"/>
+                </toc-element>
                 <toc-element topic="Andere-Engine.md"/>
             </toc-element>
             <toc-element topic="SBOM-Engine.md"/>
@@ -86,7 +115,9 @@
             <toc-element topic="Software-Entwicklung-BD.md">
                 <toc-element topic="Git-hub-Basics-und-Arbeitsweise.md"/>
             </toc-element>
-            <toc-element topic="Writerside-howto-and-best-practice-BD.md"/>
+            <toc-element topic="Writerside-howto-and-best-practice-BD.md">
+                <toc-element topic="EKJ0004.md"/>
+            </toc-element>
         </toc-element>
     </toc-element>
     <toc-element topic="Glossar.md">
@@ -127,7 +158,10 @@
         <toc-element topic="M.md"/>
         <toc-element topic="N.md"/>
         <toc-element topic="O.md"/>
-        <toc-element topic="P.md"/>
+        <toc-element topic="P.md">
+            <toc-element topic="PausenhinweisGE.md"/>
+            <toc-element topic="PausenempfehlungGE.md"/>
+        </toc-element>
         <toc-element topic="Q.md"/>
         <toc-element topic="R.md"/>
         <toc-element topic="S.md">

diff --git a/AdLerDokumentation/Writerside/images/imagePausenhinweisPlaceholder.png b/AdLerDokumentation/Writerside/images/imagePausenhinweisPlaceholder.png
diff --git a/...rDokumentation/Writerside/topics/3D-Lernraum-FunktionaleAnforderungen-Engine.md b/...rDokumentation/Writerside/topics/3D-Lernraum-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# 3D Lernraum
+
+Start typing here...
diff --git a/...tation/Writerside/topics/Adaptivitätselement-FunktionaleAnforderungen-Engine.md b/...tation/Writerside/topics/Adaptivitätselement-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Adaptivitätselement
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/Avatar-FunktionaleAnforderungen-Engine.md b/AdLerDokumentation/Writerside/topics/Avatar-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Avatar
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/EKJ0001.md b/AdLerDokumentation/Writerside/topics/EKJ0001.md
@@ -0,0 +1,16 @@
+# Pausenhinweis anzeigen
+
+
+# Definition:
+
+Nach Ablauf einer bestimmten Zeit muss die Engine einen Hinweis auf die zugehörige Pausenempfehlung anzeigen.
+
+# Akzeptanzkriterien:
+
+- Anzeige Pausenhinweis nach 30 min 
+- Anzeige Pausenhinweis nach 60 min
+- Anzeige Pausenhinweis nach 90 min
+
+# Aktivitätsdiagramm:
+
+![imagePausenhinweisPlaceholder.png](imagePausenhinweisPlaceholder.png)
diff --git a/AdLerDokumentation/Writerside/topics/EKJ0002.md b/AdLerDokumentation/Writerside/topics/EKJ0002.md
@@ -0,0 +1,15 @@
+# Pausenempfehlung anzeigen 
+
+
+# Definition:
+
+Falls der Pausenhinweis angezeigt wird muss das System dem Lernenden die Möglichkeit bieten die Pausenempfehlung anzuzeigen.
+
+# Akzeptanzkriterien:
+
+- Bei Klick öffnet sich die Pausenempfehlung
+- Es wird nach Empfehlungen für kurze, mittlere und lange Pausen unterschieden
+
+# Aktivitätsdiagramm:
+![imagePausenhinweisPlaceholder.png](imagePausenhinweisPlaceholder.png)
+
diff --git a/AdLerDokumentation/Writerside/topics/EKJ0003.md b/AdLerDokumentation/Writerside/topics/EKJ0003.md
@@ -0,0 +1,14 @@
+# Pausenempfehlung umblättern
+
+
+# Definition:
+
+Die Engine muss Lernenden die Möglichkeit bieten, die Inhalte einer Pausenempfehlung zu wechseln
+
+# Akzeptanzkriterien:
+
+
+
+# Aktivitätsdiagramm:
+
+
diff --git a/AdLerDokumentation/Writerside/topics/EKJ0004.md b/AdLerDokumentation/Writerside/topics/EKJ0004.md
@@ -0,0 +1,14 @@
+# Pausenempfehlung schließen
+
+
+# Definition:
+
+Die Engine muss Lernenden die Möglichkeit bieten, Pausenempfehlungen zu schließen
+
+
+# Akzeptanzkriterien:
+
+
+# Aktivitätsdiagramm:
+
+
diff --git a/AdLerDokumentation/Writerside/topics/EKJ0005.md b/AdLerDokumentation/Writerside/topics/EKJ0005.md
@@ -0,0 +1,14 @@
+# Pausenhinweis schließen
+
+
+# Definition:
+
+Die Engine muss Lernenden die Möglichkeit bieten, Pausenhinweise zu schließen
+
+
+# Akzeptanzkriterien:
+
+
+# Aktivitätsdiagramm:
+
+
diff --git a/AdLerDokumentation/Writerside/topics/EKJ0006.md b/AdLerDokumentation/Writerside/topics/EKJ0006.md
@@ -0,0 +1,14 @@
+# Pausenempfehlung schließen
+
+
+# Definition:
+
+Die Engine muss Lernenden die Möglichkeit bieten, die Pausenempfehlung zu schließen
+
+# Akzeptanzkriterien:
+
+- Nach Schließen der Pausenempfehlung wird der Pausenhinweis angezeigt.
+
+# Aktivitätsdiagramm:
+
+
diff --git a/AdLerDokumentation/Writerside/topics/Engine-GUI-3D-Lernraum.md b/AdLerDokumentation/Writerside/topics/Engine-GUI-3D-Lernraum.md
@@ -0,0 +1,3 @@
+# 3D Lernumgebung
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/GUI-Engine-Lernraummenü.md b/AdLerDokumentation/Writerside/topics/GUI-Engine-Lernraummenü.md
@@ -0,0 +1,3 @@
+# Lernraummenü
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/GUI-Engine-Lernweltmenü.md b/AdLerDokumentation/Writerside/topics/GUI-Engine-Lernweltmenü.md
@@ -0,0 +1,3 @@
+# Lernweltmenü
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/GUI-Engine-Startseite.md b/AdLerDokumentation/Writerside/topics/GUI-Engine-Startseite.md
@@ -0,0 +1,3 @@
+# Startseite
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/Hilemenü-FunktionaleAnforderungen-Engine.md b/AdLerDokumentation/Writerside/topics/Hilemenü-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Hilfe
+
+Start typing here...
diff --git a/...umentation/Writerside/topics/InternetVerlust-FunktionaleAnforderungen-Engine.md b/...umentation/Writerside/topics/InternetVerlust-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# InternetVerlust
+
+Start typing here...
diff --git a/...kumentation/Writerside/topics/Ladebildschirm-FunktionaleAnforderungen-Engine.md b/...kumentation/Writerside/topics/Ladebildschirm-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Ladebildschirm
+
+Start typing here...
diff --git a/...Dokumentation/Writerside/topics/Lernelemente-FunktionaleAnforderungen-Engine.md b/...Dokumentation/Writerside/topics/Lernelemente-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Lernelemente
+
+Start typing here...
diff --git a/...umentation/Writerside/topics/Lernfortschritt-FunktionaleAnforderungen-Engine.md b/...umentation/Writerside/topics/Lernfortschritt-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Lernfortschritt
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/Lernraum-FunktionaleAnforderungen-Engine.md b/AdLerDokumentation/Writerside/topics/Lernraum-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Lernraumanzeige
+
+Start typing here...
diff --git a/...Dokumentation/Writerside/topics/Lernraummenü-FunktionaleAnforderungen-Engine.md b/...Dokumentation/Writerside/topics/Lernraummenü-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Lernraummenü
+
+Start typing here...
diff --git a/...Dokumentation/Writerside/topics/Lernweltmenü-FunktionaleAnforderungen-Engine.md b/...Dokumentation/Writerside/topics/Lernweltmenü-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Lernweltmenü
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/Lernziele-FunktionaleAnforderungen-Engine.md b/AdLerDokumentation/Writerside/topics/Lernziele-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Lernziele
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/Menüleiste-FunktionaleAnforderungen-Engine.md b/AdLerDokumentation/Writerside/topics/Menüleiste-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Menüleiste
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/PausenempfehlungGE.md b/AdLerDokumentation/Writerside/topics/PausenempfehlungGE.md
@@ -0,0 +1,33 @@
+# Pausenempfehlung
+
+<link-summary rel="summary"/>
+<card-summary rel="summary"/>
+<web-summary rel="summary"/>
+
+
+<table>
+    <tr>
+        <td></td>
+        <td>Beschreibung</td>
+    </tr>
+    <tr>
+        <td>Akronym</td>
+        <td>PE</td>
+    </tr>
+    <tr>
+        <td>Begriff</td>
+        <td>Pausenempfehlung</td>
+    </tr>
+    <tr>
+        <td>Definition</td>
+        <td id="summary">Eine Pausenempfehlung gibt konkrete Handlungsempfehlungen für die Pausenzeit. Die Pausenempfehlung wird dem Nutzer in einem Modal dargestellt. </td>
+    </tr>
+   <tr>
+        <td>Synonyme</td>
+        <td></td>
+    </tr>
+   <tr>
+        <td>Verwandte Begriffe</td>
+        <td>Adaptivity - Time Spent</td>
+    </tr>
+</table>
diff --git a/AdLerDokumentation/Writerside/topics/PausenhinweisGE.md b/AdLerDokumentation/Writerside/topics/PausenhinweisGE.md
@@ -0,0 +1,33 @@
+# Pausenhinweis
+
+<link-summary rel="summary"/>
+<card-summary rel="summary"/>
+<web-summary rel="summary"/>
+
+
+<table>
+    <tr>
+        <td></td>
+        <td>Beschreibung</td>
+    </tr>
+    <tr>
+        <td>Akronym</td>
+        <td>PH</td>
+    </tr>
+    <tr>
+        <td>Begriff</td>
+        <td>Pausenhinweis</td>
+    </tr>
+    <tr>
+        <td>Definition</td>
+        <td id="summary">Eine Benachrichtigung, die auf eine Pause hinweist.  </td>
+    </tr>
+   <tr>
+        <td>Synonyme</td>
+        <td></td>
+    </tr>
+   <tr>
+        <td>Verwandte Begriffe</td>
+        <td>Adaptivity - Time Spent</td>
+    </tr>
+</table>
diff --git a/AdLerDokumentation/Writerside/topics/Pausenhinweise.md b/AdLerDokumentation/Writerside/topics/Pausenhinweise.md
@@ -0,0 +1,3 @@
+# Pausenhinweise
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/Startmenü-FunktionaleAnforderungen-Engine.md b/AdLerDokumentation/Writerside/topics/Startmenü-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Startmenü
+
+Start typing here...
diff --git a/...Dokumentation/Writerside/topics/Storyelement-FunktionaleAnforderungen-Engine.md b/...Dokumentation/Writerside/topics/Storyelement-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Storyelement
+
+Start typing here...
diff --git a/AdLerDokumentation/Writerside/topics/Türen-FunktionaleAnforderungen-Engine.md b/AdLerDokumentation/Writerside/topics/Türen-FunktionaleAnforderungen-Engine.md
@@ -0,0 +1,3 @@
+# Türen
+
+Start typing here...