Skip to Content

Changes for page Anforderungen Software

Last modified by mgrawunder on 2025/09/29 10:00
From version arrow_back 1.3 arrow_forward
edited by Pascal Meyer
on 2025/07/29 01:56
Change comment: There is no comment for this version
To version arrow_back 3.1 arrow_forward
edited by Pascal Meyer
on 2025/07/30 19:45
Change comment: There is no comment for this version

Summary

Details

insert_drive_file Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Anforderungen an die Software
1 +Anforderungen Software
Content
... ... @@ -45,7 +45,7 @@
45 45  Um gut in das SWP zu starten, gibt es drei **vordefinierte** Meilensteine.
46 46  
47 47  * Der erste Meilenstein ist durch die gemeinsame Bearbeitung der Übungsaufgaben erreicht.
48 -* Für den zweiten Meilenstein (s.u.) gibt es eine [[Präsentation>>url:https://confluence.swl.informatik.uni-oldenburg.de/spaces/SWP/pages/393401/TA+5+Zwischenpr%C3%A4sentation]]. Das ist die erste Präsentation bei mir.
48 +* Für den zweiten Meilenstein (s.u.) gibt es eine [[Zwischenpräsentation>>doc:Main.Aufgabenstellung.WebHome||anchor="HTeilaufgabe5:ZwischenprE4sentation"]]. Das ist die erste Präsentation bei mir.
49 49  * Es gibt eine Präsentation für den Prototypen (Meilenstein X), im zweiten Semester.
50 50  * Es gibt eine Präsentation für das finale Produkt (Endabnahme) zum Ende des zweiten Semesters.
51 51  
... ... @@ -83,11 +83,8 @@
83 83  * Es dürfen danach noch Änderungen und Erweiterungen gemacht werden.
84 84  
85 85  {{success}}
86 -Hinweis
87 -{{/success}}
86 +**Hinweis:**
88 88  
89 -Hinweise:
90 -
91 91  * Die Anforderungen sind die **Minimalanforderungen**.
92 92  * Es darf ruhig zum jeweiligen Zeitpunkt schon mehr realisiert werden.
93 93  * Aber: Fokus auf das Wichtige!
... ... @@ -96,16 +96,17 @@
96 96  ** kein 3D etc.
97 97  ** Die Spielanleitung kann als PDF zur Verfügung gestellt werden.
98 98  * Im Zweifelsfall ist es wichtiger, **eine gute Basis** zu haben und nicht so weit zu sein wie es der Meilenstein verlangt. Auf keinen Fall sollte man aus Gründen der Meilensteinerreichung Dinge einfach "runterhacken" um sie hinterher wieder aufzuräumen. Das wäre dann unnötige Arbeit!
96 +{{/success}}
99 99  
100 100  = Anforderungen: Dokumentation =
101 101  
102 -Im Softwareprojekt muss am Ende zusätzlich zum eigentlichen Produkt ein Dokument (das kann auch durch einen Export aus Confluence erfolgen) abgegeben werden, welches im Wesentlichen die folgenden Aspekte enthalten sollte:
100 +Im Softwareprojekt muss am Ende zusätzlich zum eigentlichen Produkt ein Dokument (das kann auch durch einen Export aus GitLab erfolgen) abgegeben werden, welches im Wesentlichen die folgenden Aspekte enthalten sollte:
103 103  
104 104  * Eine allgemeine Einleitung für das Dokument. Worum geht es und wie ist das Dokument aufgebaut.
105 105  * Grundsätzlich sollte jeder Abschnitt kurz eingeleitet werden und jeden Kapitel sollte eine kurze Zusammenfassung bekommen.
106 106  * Quellen müssen angebenen werden, also z.B. nicht einfach Text von einer Web-Seite kopieren. Das kann u.U. als Plagiat ausgelegt werden...
107 107  * Eine Darstellung der ermittelten Anforderungen.
108 -** Dies umfasst mindestens die umgesetzten User-Stories (Sinnvoll: Die Akzeptanzkriterien für eine User-Story mit angeben.). Idealerweise werden die UserStories noch durch Anwendungsfälle unterstützt.
106 +** Dies umfasst mindestens die umgesetzten User-Stories (Sinnvoll: Die Akzeptanzkriterien für eine User-Story mit angeben.). Idealerweise werden die UserStories (siehe [[User-Stories>>doc:Main.Scrum.WebHome||anchor="HUserStories"]]) noch durch Anwendungsfälle unterstützt.
109 109  ** Ggf. eine Darstellung/Auflistung nicht umgesetzter User Stories. Die kann noch einmal zeigen, welche kreativen Ideen zeitlich nicht mehr umgesetzt wurden
110 110  ** Die Stories sollten möglichst gruppiert (z.B. nach Nutzerverwaltung, Hauptmenue/Lobby, etc.) werden.
111 111  * Darstellung der Realisierung
... ... @@ -153,7 +153,7 @@
153 153  ** Ggf. vollständige Klassendiagramme (Ohne weitere Erläuterung)
154 154  ** Protokolle und andere im Laufe der Zeit entstandene Dokumente in speziellen Ordner hinterlegen. **Nicht (mehr) in das Dokument mit aufnehmen**, das ist nur unnötige Arbeit.
155 155  * Glossar mit Begriffen des Gegenstandes/Spiels
156 -* Index  (Falls Dokument mit LaTeX erstellt, bei Confluence-Export nicht möglich/notwendig)
154 +* Index  (Falls Dokument mit LaTeX erstellt, bei GitLab-Export nicht möglich/notwendig)
157 157  
158 158  Ich werde immer wieder gefragt, wieviele Seiten die Dokumentation haben muss. Das lässt sich so pauschal leider nicht sagen, denn das hängt zum einen natürlich massiv von der verwendeten Vorlage ab, zum anderen aber auch davon, welches die aktuelle Aufgaben gewesen ist. Zur Orientierung kann man jedoch sagen, dass die typische (gelungene) (LaTeX-basierte-)Dokumentation in den letzten Jahren immer so in dem Bereich von 80 bis 100 Seiten (inkl. Anhängen und Bildern) gelegen hat. Es macht nun aber keinen Sinn, die Seitenanzahl künstlich durch "unnötigen" Inhalt aufzublähen. Ich schaue schon sehr genau darauf, wie gelungen und vollständig die oben genannten Punkte abgehandelt werden.
159 159  
... ... @@ -164,12 +164,14 @@
164 164  
165 165  Im Git-Repository gibt es eine Dokumentationsvorlage für LaTeX.
166 166  
167 -Hinweise:
165 +{{success}}
166 +**Hinweis:**
168 168  
169 169  * Falls es Widersprüche zwischen der Vorlage und dem Text hier im Wiki gibt, bitte eine kurze Nachricht. Im Zweifelsfall zählt der Inhalt aus dem Wiki.
170 170  * Falls etwas nicht korrekt funktioniert, bitte auch eine kurze Nachricht. Ich kümmere mich.
171 171  * Gruppen, die ihre Dokumentation auch im git pflegen wollen, können mir einen Nachricht schicken und ich richte das Repo dann passend ein.
172 172  * [[https:~~/~~/git.swl.informatik.uni-oldenburg.de/projects/SPB/repos/dokumentation/browse/>>url:https://git.swl.informatik.uni-oldenburg.de/projects/SPB/repos/dokumentation/browse/]]
172 +{{/success}}
173 173  
174 174  = Anforderungen: Nutzung von KI Tools =
175 175  
... ... @@ -178,8 +178,7 @@
178 178  **~1. Transparenzpflicht:**
179 179  Alle von KI-Tools generierten Code- oder Textpassagen müssen im Code oder in den Abgaben klar als solche gekennzeichnet werden. Zum Beispiel durch Kommentare wie
180 180  
181 -{{{// Generated with ChatGPT at 31.03.2025
182 -}}}
181 +|~/~/ Generated with ChatGPT at 31.03.2025
183 183  
184 184  **Ausnahme**: Die Vervollständigung einer Zeile (durch Tab) ist nicht speziell zu dokumentieren ("Local Full Line Completion"), alles weitergehende auf jeden Fall.
185 185