Skip to Content

Changes for page Dokumentation

Last modified by Marco Grawunder on 2026/10/06 15:53
From version 5.1
edited by Marco Grawunder
on 2026/10/06 15:53
Change comment: There is no comment for this version
To version 1.1
edited by Marco Grawunder
on 2026/08/25 14:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,15 +1,5 @@
1 -{{info}}
2 -**Worum geht es auf dieser Seite?**
1 += Teilaufgabe 2: Anforderungsanalyse (Dokumentation) =
3 3  
4 -Diese Seite beschreibt, **was während des Projekts und für die finale Abgabe dokumentiert werden soll**. Dazu gehören Anforderungsanalyse, Architektur und Entwurf, geeignete Modelle sowie die Anforderungen an die Abschlussdokumentation.
5 -
6 -Die Dokumentation soll den Projektverlauf begleiten und schrittweise mit der Software weiterentwickelt werden.
7 -
8 -**Jede Gruppe bekommt neben dem Repository für die Software auch ein Repository für die Dokumentation. Damit die Versionierung vereinfacht wird und sich Dinge einfach rückgängig machen lassen, würde ich auch dazu raten, dieses Doku-Repo zu verwenden.**
9 -{{/info}}
10 -
11 -= Anforderungsanalyse =
12 -
13 13  * Was soll umgesetzt werden? Wie sieht diese Welt aus?
14 14  ** Wer sind die Akteure?
15 15  ** Welche User-Stories gibt es?
... ... @@ -20,10 +20,10 @@
20 20  *** Aktivitätsdiagramm und Zustandsdiagramm: Kann erstmal auf einer abstrakten Ebene passieren und später verfeinert werden
21 21  * Dokumentation schrittweise (!) anpassen/erweitern
22 22  * Abgabe:
23 -** [[Zwischenpräsentation>>doc:Main.Präsentationen.WebHome]] (siehe dort)
13 +** [[Zwischenpräsentation>>doc:Main.Aufgabenstellung.WebHome||anchor="HTeilaufgabe5:ZwischenprE4sentation"]] (siehe dort)
24 24  ** zum Ende des Projektes finale Version
25 25  ** Dokumentation in einem extra Dokument (nicht auf GitLab verweisen).
26 -* Beachten: [[Anforderungen Dokumentation>>doc:Main.Dokumentation.WebHome||anchor="HAnforderungen:Dokumentation"]]
16 +* Beachten: [[Anforderungen Dokumentation>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:Dokumentation"]]
27 27  * In Gitlab steht draw.io zur Verfügung. Damit können Diagramme gezeichnet werden. [[https:~~/~~/www.drawio.com/blog/gitlab-wiki-integration>>https://www.drawio.com/blog/gitlab-wiki-integration]]
28 28  * Es gibt in Gitlab auch die Möglichkeit, Diagramme textuell zu beschreiben (Mermaid oder PlantUML) und dann generieren zu lassen: [[https:~~/~~/docs.gitlab.com/user/markdown/#mermaid>>https://docs.gitlab.com/user/markdown/#mermaid]], gerade bei Sequenzdiagrammen kann dies die Erstellung deutlich vereinfachen. Weitere Infos unter: [[https:~~/~~/docs.gitlab.com/user/markdown/#diagrams-and-flowcharts>>https://docs.gitlab.com/user/markdown/#diagrams-and-flowcharts]]
29 29  
... ... @@ -35,7 +35,7 @@
35 35  * Achtung! Wenn Sie Visual Paradigm verwenden, ändern Sie die Version nicht während des Projektes. I.d.R. sind die Modelle nicht beliebig austauschbar.
36 36  {{/warning}}
37 37  
38 -= Architektur und Entwurf =
28 += Teilaufgabe 3: Entwurf (Dokumentation) =
39 39  
40 40  * Zerlegung in Teilsysteme
41 41  * Bildung von Modulen (Klassen zu Gruppen zusammenfassen) Kopplung und Kohäsion beachten
... ... @@ -46,10 +46,10 @@
46 46  * Make or Buy (Verwendung von Frameworks)
47 47  * Dokument: System- und Objektentwurf
48 48  * Abgabe:
49 -** [[Zwischenpräsentation>>doc:Main.Präsentationen.WebHome]] (siehe dort)
39 +** [[Zwischenpräsentation>>doc:Main.Aufgabenstellung.WebHome||anchor="HTeilaufgabe5:ZwischenprE4sentation"]] (siehe dort)
50 50  ** zum Ende des Projektes finale Version
51 51  ** Dokumentation in einem extra Dokument (nicht auf GitLab verweisen)
52 -* Beachten: [[Anforderungen Dokumentation>>doc:Main.Dokumentation.WebHome||anchor="HAnforderungen:Dokumentation"]]
42 +* Beachten: [[Anforderungen Dokumentation>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:Dokumentation"]]
53 53  
54 54  = Anforderungen: Dokumentation =
55 55  
... ... @@ -129,8 +129,3 @@
129 129  * [[https:~~/~~/gitlab.swl.informatik.uni-oldenburg.de/SPB/dokumentation>>https://gitlab.swl.informatik.uni-oldenburg.de/SPB/dokumentation]]
130 130  {{/success}}
131 131  
132 -= Siehe auch =
133 -
134 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
135 -* [[Glossar>>doc:Main.Glossar.WebHome]]
136 -* [[Präsentationen und Abnahme>>doc:Main.Präsentationen.WebHome]]