Changes for page Dokumentation

Last modified by Marco Grawunder on 2026/10/06 15:53

From version 4.1
edited by Marco Grawunder
on 2026/08/26 10:13
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,13 +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 -{{/info}}
8 -
9 -= Anforderungsanalyse =
10 -
11 11  * Was soll umgesetzt werden? Wie sieht diese Welt aus?
12 12  ** Wer sind die Akteure?
13 13  ** Welche User-Stories gibt es?
... ... @@ -18,10 +18,10 @@
18 18  *** Aktivitätsdiagramm und Zustandsdiagramm: Kann erstmal auf einer abstrakten Ebene passieren und später verfeinert werden
19 19  * Dokumentation schrittweise (!) anpassen/erweitern
20 20  * Abgabe:
21 -** [[Zwischenpräsentation>>doc:Main.Präsentationen.WebHome]] (siehe dort)
13 +** [[Zwischenpräsentation>>doc:Main.Aufgabenstellung.WebHome||anchor="HTeilaufgabe5:ZwischenprE4sentation"]] (siehe dort)
22 22  ** zum Ende des Projektes finale Version
23 23  ** Dokumentation in einem extra Dokument (nicht auf GitLab verweisen).
24 -* Beachten: [[Anforderungen Dokumentation>>doc:Main.Dokumentation.WebHome||anchor="HAnforderungen:Dokumentation"]]
16 +* Beachten: [[Anforderungen Dokumentation>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:Dokumentation"]]
25 25  * 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]]
26 26  * 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]]
27 27  
... ... @@ -33,7 +33,7 @@
33 33  * Achtung! Wenn Sie Visual Paradigm verwenden, ändern Sie die Version nicht während des Projektes. I.d.R. sind die Modelle nicht beliebig austauschbar.
34 34  {{/warning}}
35 35  
36 -= Architektur und Entwurf =
28 += Teilaufgabe 3: Entwurf (Dokumentation) =
37 37  
38 38  * Zerlegung in Teilsysteme
39 39  * Bildung von Modulen (Klassen zu Gruppen zusammenfassen) Kopplung und Kohäsion beachten
... ... @@ -44,10 +44,10 @@
44 44  * Make or Buy (Verwendung von Frameworks)
45 45  * Dokument: System- und Objektentwurf
46 46  * Abgabe:
47 -** [[Zwischenpräsentation>>doc:Main.Präsentationen.WebHome]] (siehe dort)
39 +** [[Zwischenpräsentation>>doc:Main.Aufgabenstellung.WebHome||anchor="HTeilaufgabe5:ZwischenprE4sentation"]] (siehe dort)
48 48  ** zum Ende des Projektes finale Version
49 49  ** Dokumentation in einem extra Dokument (nicht auf GitLab verweisen)
50 -* Beachten: [[Anforderungen Dokumentation>>doc:Main.Dokumentation.WebHome||anchor="HAnforderungen:Dokumentation"]]
42 +* Beachten: [[Anforderungen Dokumentation>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:Dokumentation"]]
51 51  
52 52  = Anforderungen: Dokumentation =
53 53  
... ... @@ -127,9 +127,3 @@
127 127  * [[https:~~/~~/gitlab.swl.informatik.uni-oldenburg.de/SPB/dokumentation>>https://gitlab.swl.informatik.uni-oldenburg.de/SPB/dokumentation]]
128 128  {{/success}}
129 129  
130 -= Siehe auch =
131 -
132 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
133 -* [[Glossar>>doc:Main.Glossar.WebHome]]
134 -* [[Präsentationen und Abnahme>>doc:Main.Präsentationen.WebHome]]
135 -