Changes for page Anforderungen Software
Last modified by mgrawunder on 2025/09/29 10:00
From 7.1 to 6.2
From 9.1 to 8.1
From version 8.1
edited by mgrawunder
on 2025/09/24 09:04
on 2025/09/24 09:04
Change comment:
There is no comment for this version
To version 7.1
edited by mgrawunder
on 2025/09/11 13:13
on 2025/09/11 13:13
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -104,11 +104,11 @@ 104 104 105 105 * Eine allgemeine Einleitung für das Dokument. Worum geht es und wie ist das Dokument aufgebaut. 106 106 * Grundsätzlich sollte jeder Abschnitt kurz eingeleitet werden und jeden Kapitel sollte eine kurze Zusammenfassung bekommen. 107 -* Quellen müssen ange gebenen werden, also z.B. nicht einfach Text von einer Web-Seite kopieren. Das kann u.U. als Plagiat ausgelegt werden...107 +* Quellen müssen angebenen werden, also z.B. nicht einfach Text von einer Web-Seite kopieren. Das kann u.U. als Plagiat ausgelegt werden... 108 108 * Eine Darstellung der ermittelten Anforderungen. 109 109 ** 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. 110 110 ** Ggf. eine Darstellung/Auflistung nicht umgesetzter User Stories. Die kann noch einmal zeigen, welche kreativen Ideen zeitlich nicht mehr umgesetzt wurden 111 -** Die Stories sollten möglichst gruppiert (z.B. nach Nutzerverwaltung, Hauptmen ü/Lobby, etc.) werden.111 +** Die Stories sollten möglichst gruppiert (z.B. nach Nutzerverwaltung, Hauptmenue/Lobby, etc.) werden. 112 112 * Darstellung der Realisierung 113 113 ** Allgemeine/Übergreifende Konzepte, z.B. wie wurde MVP realisiert 114 114 *** Darstellung der Architektur und Aufteilung des Gesamtsystems in Module ... ... @@ -125,7 +125,6 @@ 125 125 **** Nicht immer ist offensichtlich, warum eine Lösung gewählt wurde. In diesem Fall sollten (Entwurfs-)Entscheidungen begründet/motiviert werden. Es ist grundsätzlich eine gute Idee, Dinge nicht nur „mitzuteilen“, sondern zu „erklären“. 126 126 **** Wenn man komplexere Algorithmen darstellen möchte, kann es besser sein, die Darstellung mit Pseudocode vorzunehmen. 127 127 *** Diagramme sollten an den Stellen im Text sein, an denen sie erläutert werden. Es muss vom Text aus auf die Diagramme verwiesen ("siehe Abb. X.Y") werden. Einfach alle im Anhang aufzulisten, macht keinen Sinn. 128 -*** Hinweise: Man kann Diagramme in Gitlab auch textuell erzeugen: [[https:~~/~~/docs.gitlab.com/user/markdown/#diagrams-and-flowcharts>>https://docs.gitlab.com/user/markdown/#diagrams-and-flowcharts]] Macht es u.U. gerade bei komplexen Diagrammen einfacher. 129 129 ** Bei Spiel: Regelabweichungen darstellen und begründen 130 130 ** (Java-)Quellcode im Text möglichst vermeiden. Pseudocode kann für die Beschreibung von komplexeren Algorithmen verwendet werden. 131 131 ** **ACHTUNG**! Die Konzepte bitte so darstellen, als wenn sie nicht iterativ entstanden wären. Also keine "Verteilung" des Konzeptes auf Sprints. Wichtig ist, was am Ende herausgekommen ist. ... ... @@ -157,7 +157,7 @@ 157 157 * Glossar mit Begriffen des Gegenstandes/Spiels 158 158 * Index (Falls Dokument mit LaTeX erstellt) 159 159 160 -Ich werde immer wieder gefragt, wie 159 +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. 161 161 162 162 Zum Produkt selber noch notwendig: 163 163