Skip to Content

Changes for page Anforderungen Software

Last modified by mgrawunder on 2025/09/29 10:00
From version arrow_back 4.1 arrow_forward
edited by Marco Grawunder
on 2025/08/15 08:52
Change comment: There is no comment for this version
To version arrow_back 5.1 arrow_forward
edited by pmeyer
on 2025/08/28 18:56
Change comment: There is no comment for this version

Summary

Details

insert_drive_file Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.MarcoGrawunder
1 +XWiki.pmeyer
Content
... ... @@ -99,7 +99,7 @@
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 GitLab erfolgen) abgegeben werden, welches im Wesentlichen die folgenden Aspekte enthalten sollte:
102 +Im Softwareprojekt muss am Ende zusätzlich zum eigentlichen Produkt ein Dokument 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.
... ... @@ -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 GitLab-Export nicht möglich/notwendig)
156 +* Index  (Falls Dokument mit LaTeX erstellt)
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  
... ... @@ -169,7 +169,7 @@
169 169  
170 170  * 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.
171 171  * Falls etwas nicht korrekt funktioniert, bitte auch eine kurze Nachricht. Ich kümmere mich.
172 -* Gruppen, die ihre Dokumentation auch im git pflegen wollen, können mir einen Nachricht schicken und ich richte das Repo dann passend ein.
172 +* Gruppen, die ihre Dokumentation auch im Git pflegen wollen, können mir einen Nachricht schicken und ich richte das Repo dann passend ein.
173 173  * [[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/]]
174 174  {{/success}}
175 175