Wiki source code of Projektarbeit

Last modified by Marco Grawunder on 2026/08/26 10:15

Show last authors
1 {{info}}
2 **Worum geht es auf dieser Seite?**
3
4 Diese Seite beschreibt die **Organisation und Zusammenarbeit innerhalb der Projektgruppe**. Dazu gehören Projektmanagement, gemeinsame Arbeitsregeln, individuelle Verantwortungsbereiche, Projekttagebuch, wechselnde Sitzungsaufgaben und das gruppenweite Code-Review.
5
6 Für die methodischen Scrum-Grundlagen siehe [[Scrum>>doc:Main.Scrum.WebHome]], für die technische Abbildung der Projektarbeit [[GitLab Erklärungen>>doc:Main.GitLab.WebHome]].
7 {{/info}}
8
9 {{toc/}}
10
11 = Projektmanagement organisieren =
12
13 * Organisieren Sie Ihr Projekt bzw. Team,
14 ** verteilen Sie in der zweiten Woche die [[Einzelaufgaben>>doc:Main.Projektarbeit.WebHome||anchor="HIndividuelleVerantwortungsbereicheundEinzelaufgaben"]],
15 ** definieren Sie eine Reihenfolge für die Übernahme der Moderation und des Protokolls (z.B. nach Alphabet)
16 ** die Tagesordnung ist vom Moderator mindestens einen Tag vorher zu erstellen (dafür ggf. die Gruppe nach weiteren TOPs fragen)
17 ** definieren Sie Standards für Dokumente (LaTeX, UTF-8, ...)
18 ** Führen Sie ein [[Projekttagebuch>>doc:Main.Projektarbeit.WebHome||anchor="HProjekttagebuch"]] (im Wiki)
19 * Dokumentieren Sie immer alle Ergebnisse der Gruppe, wie
20 ** Protokolle,
21 ** Ausarbeitungen,
22 ** Präsentationen,
23 ** Software-Dokumente, etc.
24 * mit einer Zuordnung zu Personen in GitLab. **Verwenden Sie dafür die Wiki-Funktion von Gitlab** ([[https:~~/~~/docs.gitlab.com/user/project/wiki/>>https://docs.gitlab.com/user/project/wiki/]]).
25 * Geben Sie die Einzelaufgaben an
26 * Stellen Sie ein Gruppenbild (mit Namen) ein! Ideal ist es für mich und die Tutoren, wenn in dem Bild die Namen direkt als Text enthalten sind.
27 * Überlegen Sie sich für Ihre Aufgaben eine "Definition of Ready" und eine "Definition of Done", d.h. was muss für eine Aufgabe erledigt sein, bevor sie als erledigt angesehen werden kann. (siehe z.B. [[https:~~/~~/www.scrum-events.de/was-ist-die-definition-of-done-dod.html>>url:https://www.scrum-events.de/was-ist-die-definition-of-done-dod.html]])
28 * Erstellen Sie basierend auf den Vorgaben der Veranstaltung eine Produktvision. (vgl. z.B. [[https:~~/~~/www.wibas.com/scrum/product-vision/de)>>url:https://www.wibas.com/scrum/product-vision/de]]
29
30 Sprints allein gewährleisten noch keine langfristige Orientierung. Definieren Sie deshalb zusätzliche **Meilensteine**, zu denen konkrete fachliche Ergebnisse erreicht sein sollen. Einige sind vorgegeben (vgl. [[Meilensteine>>doc:Main.Softwareentwicklung.WebHome||anchor="HVorgegebeneMeilensteine"]]). Verwenden Sie zur Meilensteindefinition nicht nur die Präsentationstermine!
31
32 = Zusammenarbeit und Verhaltensregeln =
33
34 * **Allgemeine Regeln innerhalb der Gruppe**
35 ** alle
36 *** sind vorbereitet und nehmen aktiv teil
37 *** erledigen ihre Aufgaben vollständig und pünktlich
38 *** übernehmen aktiv Aufgaben
39 *** beachten Gruppenstandards
40 *** sind bereit, ihre Arbeit auf Fehler untersuchen zu lassen
41 **** Grundsätzliche Kritik bitte zunächst unmittelbar an eine Person, dann Gruppe, dann Tutor, dann Dozent
42 **** Es gibt in jeder Gruppe einen Konfliktbeauftragten (siehe [[Anforderungen Einzelleistungen>>doc:Main.Projektarbeit.WebHome||anchor="HIndividuelleVerantwortungsbereicheundEinzelaufgaben"]]) geben
43 *** Diskriminierung wird in keinster Form geduldet! (siehe [[Spielregeln>>doc:Main.Projektarbeit.WebHome||anchor="HZusammenarbeitundVerhaltensregeln"]])
44 *** Konsequenzen bei Nichterfüllung von übertragenen Aufgaben festlegen?
45 ** Jeder übernimmt Teile bei
46 *** Dokumentation und
47 *** Implementierung
48 *** keine „Doku-Sklaven“!
49 * **Kommunikationsregeln innerhalb der Gruppe**
50 ** Es sollte stets ein respektvoller Umgangston herrschen.
51 ** Jedes Gruppenmitglied hat das Recht auf freie Meinungsäußerung und wird in Gesprächen,
52 Diskussionen oder Vorstellungen nicht unterbrochen.
53 ** Gespräche und Diskussionen jeglicher Art finden stets auf einer sachlichen Ebene statt. Beleidigungen
54 jeglicher Form werden nicht toleriert.
55 ** Zwischenmenschliche Probleme werden direkt offen und nicht hinter dem Rücken des betreffenden
56 Gruppenmitgliedes kommuniziert.
57 * **Verhaltensregeln innerhalb der Gruppe**
58 ** Alle Gruppenmitglieder werden stets mit Respekt behandelt.
59 ** Kritik wird stets konstruktiv auf einer sachlichen Ebene geäußert.
60 ** Im Sinne der Projektarbeit kann der Fall eintreten, dass persönliche Ansichten zurückgestellt
61 werden müssen. Es wird somit ein hohes Maß an Kompromissbereitschaft vorausgesetzt.
62 ** Meinungen, welche von den eigenen Ansichten abweichen, werden stets toleriert.
63 ** Bei verursachten Fehlern wird stets die volle Verantwortung für das eigene Handeln übernommen.
64
65 == Keine Tolerierung von Diskriminierung jeglicher Art ==
66
67 Leider sind wir im Rahmen des „Software Projektes“ auf eine Reihe von Vorfällen aufmerksam geworden, bei denen es um sexualisiertes Verhalten oder Herabwürdigung aufgrund des Geschlechtes geht. Diese Vorfälle reichen von vermeintlich harmlosen „dummen Sprüchen“ bis hin zu direktem unerwünschtem körperlichem Kontakt.
68
69 Ich möchte noch einmal ausdrücklich darauf hinweisen, dass wir als Department für Informatik und natürlich auch als Universität Oldenburg jede Art von Diskriminierung in keiner Weise tolerieren. Ein solches Vorkommnis kann bis zum Ausschluss von der Veranstaltung, in weitergehenden Fällen sogar bis zur Exmatrikulation führen!
70
71 Wir wissen, dass dies in der großen Masse lediglich Einzelfälle sind, und es geht auf keinen Fall darum, das gesamte „Software Projekt“ zu beschuldigen. Wir möchten jedoch jeden Einzelnen und jede Einzelne dafür sensibilisieren, auf solche Situationen zu achten und gegebenenfalls entschärfend einzuwirken.
72
73 Die Betroffenen bitte ich darum, das Thema nicht mit sich herumzutragen, sondern die möglichen Kontaktmöglichkeiten zu nutzen. Nur dann, wenn das Thema offensiv angegangen wird, besteht die Chance, dass die Sensibilität für das Thema steigt!
74
75 Nachfolgend werden einige Informationen über Diskriminierung & Gewalt, dessen "Alarmglocken", Präventionsmöglichkeiten, Handlungsempfehlungen und die Aufgaben der Erstberatung zur Verfügung gestellt.
76
77 [[Alarmglocken>>attach:Alarmglocken.pdf]]
78
79 [[Aufgaben Erstberatung>>attach:Aufgaben Erstberatung.pdf]]
80
81 [[Handlungsempfehlungen Bystander>>attach:Handlungsempfehlungen Bystander_14.04.23.pdf]]
82
83 [[Prävention>>attach:Prävention.pdf]]
84
85 [[Sexualisierte Diskriminierung und Gewalt>>attach:Sexualisierte Diskriminierung und Gewalt.pdf]]
86
87 **Kontaktmöglichkeiten**
88
89 * Tutor/Tutorin der Gruppe
90 * Dozent der Veranstaltung
91 * Fachschaft Informatik: [[https:~~/~~/fachschaft-informatik.de/>>url:https://fachschaft-informatik.de/]]
92 * Dezentrale Gleichstellungbeauftragte der Informatik: [[https:~~/~~/uol.de/informatik/department/gremien-beauftragte/beauftragte>>url:https://uol.de/informatik/department/gremien-beauftragte/beauftragte]]
93 * Direktor/Direktorin des Departments: [[https:~~/~~/uol.de/informatik>>url:https://uol.de/informatik]]
94 * Erstanlaufstelle Antidiskriminierung des AStA: Donnerstags: 10:30 - 13:30 Uhr de/eng/farsi im AStA Trakt, Raum M1-157, [[beratung@asta-uol.de>>mailto:beratung@asta-uol.de||style="background-color: rgb(255, 255, 255);"]],
95 * conTakt: [[https:~~/~~/uol.de/contakt-beratungsstelle>>url:https://uol.de/contakt-beratungsstelle]]
96
97 = Individuelle Verantwortungsbereiche und Einzelaufgaben =
98
99 Neben der eigentlichen Softwareentwicklung gibt es spezielle Aufgaben, die von den Teammitglieder als Querschnittsaufgaben übernommen werden müssen. Diese Spezialisten und Verantwortlichen arbeiten sich in das Thema ein, beraten die Mitglieder der Gruppe und sorgen dafür, dass die Anforderungen an diese Aufgabe eingehalten werden. Die Aufgaben können dabei von einzelnen Personen oder auch zu zweit übernommen werden. Die Rollen sind als **Querschnitts- und Serviceaufgaben** zu verstehen. Wenn in einem Zeitraum für einen Verantwortungsbereich wenig Bedarf besteht, soll nicht künstlich Arbeit erzeugt werden; die Person unterstützt dann die reguläre Projektarbeit oder andere Verantwortungsbereiche. Entscheidend ist, dass es für das jeweilige Thema eine klar benannte Person gibt, die sich zuständig fühlt, bei Fragen unterstützen kann und darauf achtet, dass die vereinbarten Anforderungen berücksichtigt werden. In den Einschätzungen der Tutoren gibt es dafür auch ein Feld, welche die Felder "erfüllt", "nicht erfüllt" oder "war nicht notwendig" enthält.
100
101 Die kurzen Einführungen zu den Verantwortungsbereichen des ersten Blocks sollen im ersten Semester, möglichst innerhalb der ersten sieben Wochen, durchgeführt werden.
102
103 Die Einzelaufgaben sollten **erst beim zweiten Treffen** vergeben werden. Vorher sollte sich jeder darüber informieren, was die Einzelaufgabe beinhaltet.
104
105 == Kurzvortrag ==
106
107 Jeder muss einen Kurzvortrag halten, i.d.R. bezogen auf die Rolle
108
109 * Umfang ca. 10 Minuten
110 * Bezug auf die Gruppe und das SWP
111 * Vortrag muss hinterher im Gitlab-Wiki abgelegt werden
112
113 == Verantwortungsbereiche / Rollen ==
114
115 {{info}}
116 Der Aufwand der Verantwortungsbereiche ist unterschiedlich und kann sich im Projektverlauf verändern. Die Einstufungen sind daher nur als Orientierung zu verstehen.
117 {{/info}}
118
119 {{expandable summary="Scrum-Master"}}
120 * Sorgt dafür, dass der Scrum-Prozess am Laufen bleibt
121 * Kurze Zusammenfassung zu [[Scrum>>doc:Main.Scrum.WebHome||anchor="HEinkurzerDCberblick"]], ausführlicher in den Folien der VL und in [[Scrum im Detail>>doc:Main.Scrum.WebHome||anchor="HImDetail"]].
122 * Es sollte auf jeden Fall einen Stellvertreter geben, der ggf. die Rolle übernehmen kann (z.B. bei Krankheit oder Beendigung des SWPs).
123 * Diese Rolle ist mit die wichtigste Rolle im SWP und verlangt durchgehend sehr viel Kapazität. Ein Scrum-Master ist aus diesem Grund typischerweise weniger (aber trotzdem noch) an der Implementierung beteiligt.
124 * Der Scrum-Master kann zu Beginn des Softwareprojekts an einem Workshop teilnehmen (Einladung erfolgt zu Beginn) - die Teilnahme ist empfohlen.
125 * Der Scrum-Master kann während des gesamten Projekts hinweg an einem monatlichen **Scrum-Master-Treffen** teilnehmen (nähere Informationen werden im Workshop mitgeteilt) - die Teilnahme ist empfohlen.
126 * Aufwand: Sehr hoch
127 {{/expandable}}
128
129 {{expandable summary="GitLab, Projektplanung und Product Owner"}}
130 * Scrum hat das Problem, dass man beliebig "herumiterieren" kann. Diese Rolle soll dafür sorgen, dass das "Große und Ganze" nicht aus den Augen verloren geht. Die grundlegend definierten Meilensteine sollten dabei um weitere Meilensteine ergänzt werden. Diese Meilensteine sollen dabei helfen, Sprintziele zu definieren.
131 * Projektplan/Meilensteinplan erstellen, aktualisieren und überwachen. Dabei ist es nicht notwendig, ein vollständiges Gantt-Diagramm über das komplette Semester zu erstellen.
132 * [[Projekttagebuch>>doc:Main.Projektarbeit.WebHome||anchor="HProjekttagebuch"]] führen
133 * Stundenzettelpflege überwachen
134 * Weiterhin soll diese Person als Ansprechpartner für GitLab dienen, d.h. sie sollte sich besonders informieren und ggf. bei Fragen und Problemen beratend zur Seite stehen.
135 * Die Person übernimmt gemeinsam mit dem Tutor wesentliche Aufgaben des Product Owners: Sie achtet darauf, dass ausreichend vorbereitete Einträge im Product Backlog vorhanden sind und unterstützt deren Priorisierung.
136 * Sie achtet darauf, dass für die Arbeit im Sprint die vereinbarte Definition of Done berücksichtigt wird.
137 * Sie organisiert das Backlog Refinement. Dazu können kleinere, wechselnd zusammengesetzte Teilgruppen (**Ticket-Task-Force**) neue Tickets formulieren und Beschreibungen verbessern. Die Teilnehmer der Teilgruppen dürfen nicht über den ganzen Durchgang gleich bleiben sondern muss im Laufe der Zeit wechseln. Sollte die Gruppe sich gegen eine Ticket-Task-Force entscheiden, können die Tickets und Ticketbeschreibungen auch in der gesamten Gruppe gemeinsam erarbeitet werden.
138 * Aufwand: Hoch
139 {{/expandable}}
140
141 {{expandable summary="Client-Server-Kommunikation: OpenAPI, REST, WebSockets und Spring"}}
142 * Kennt sich mit den entsprechenden Technologien aus und dient als Ansprechpartner
143 * Aufwand: Kann sehr variieren
144 * Bei größeren Gruppen kann der Verantwortungsbereich sinnvoll in **API/Kommunikation (OpenAPI, REST, WebSockets)** und **Spring/serverseitige Architektur** aufgeteilt werden.
145 {{/expandable}}
146
147 {{expandable summary="Git/GitLab und Reviewbeauftragter"}}
148 * Der Inhaber kennt sich mit Git und Gitlab aus.
149 * Er kann in nicht Standard-Fällen helfen (z.B. wenn ein Mergen zu Konflikten führt)
150 * Der Inhaber dieser Rolle sollte sich auch darum kümmern, dass der Git-Workflow (Ticket → Branch → PR → Mergen) eingehalten, dass Merge-Requests sinnvoll abgearbeitet werden und nicht zu lange liegen bleiben.
151 * Im Laufe der Zeit sollte diese Rolle weniger wichtig werden, da alle den Workflow verinnerlicht haben.
152 * Die Gruppe muss mindestens ein gruppenweites Code-Review durchführen
153 * Der Review-Beauftragte ist dafür zuständig, dieses Review anzuleiten und rechtzeitig zu initiieren.
154 * Zusammen mit dem Codequalitätsbeauftragtem für die sinnvolle Durchführung der Abarbeitung der Merge-Requests zuständig.
155 * Aufwand: Mittel
156 {{/expandable}}
157
158 {{expandable summary="Codequalitätsbeauftragter und Patternbeauftragter"}}
159 * Überwachung von Codierungsstandards
160 * Kennt sich mit Refactorings aus
161 * Kennt sich mit Code-Smells aus, also, was macht guten und was macht schlechten Code aus
162 * Kennt sich mit Werkzeugen wie SpotBugs, Checkstyle und SonarLint/SonarQube aus.
163 * Soll sich in die wichtigsten Pattern (wie MVP, Observer, Command-Pattern) einarbeiten
164 * Die Gruppe bei der Anwendung der Pattern unterstützen
165 * Den Code darauf hin untersuchen, ob an bestimmten Stellen Pattern besser gewesen wären
166 * Aufwand: Mittel
167 {{/expandable}}
168
169 {{expandable summary="Testbeauftragter"}}
170 * Der Testbeauftragte ist nicht dafür da, Tests zu schreiben!
171 * Die Person stellt ggf. Mockito und JUnit vor
172 * Der Testbeauftragte unterstützt die Gruppe beim Schreiben von Tests und steht bei Fragen beratend zur Verfügung.
173 * Die Person achtet darauf, dass Tests nicht vernachlässigt werden, betrachtet regelmäßig die vorhandene Testabdeckung und macht auf unzureichend getestete Bereiche aufmerksam.
174 * Die Person sorgt dafür, dass Tests, die nicht automatisiert erstellt werden (z.B. Test von Oberflächen) dokumentiert werden.
175 * Aufwand: Mittel
176 {{/expandable}}
177
178 {{expandable summary="Dokumentations- und Backupbeauftragter, Wiki, LaTeX-Beauftragter"}}
179 * Achtet darauf, dass die erforderlichen Dokumente erstellt, kontinuierlich gepflegt und gesichert werden. Die Rolle ist **nicht** dafür zuständig, die gesamte Dokumentation allein zu schreiben.
180 * Erstellung/Anpassung von Vorlagen, Hilfe
181 * Musterdokumente, Standards, Ablagestrategie, Qualitätssicherung, Bereitstellungsstrategie
182 * Die Rolle achtet darauf, dass Dinge die fertig sind, auch bereits dann ausreichend dokumentiert werden.
183 * Aufwand: Mittel
184 {{/expandable}}
185
186 {{expandable summary="Konfliktmanagement"}}
187 * Es kommt ab und zu vor, dass im SWP gruppeninterne Konflikte auftreten.
188 * Diese Rolle soll sich im Vorfeld (also bevor etwas "schief" geht), damit befassen, welche Methoden und Ansätze es gibt, in Gruppen mit solchen Konflikten umzugehen.
189 * Es macht Sinn, dass es jemanden zweiten gibt, der sich als Stellvertreter ebenfalls mit dieser Aufgabe befasst, falls die Person, die diese Rolle eigentlich inne hat, selber der Auslöser eines Konfliktes ist.
190 * Aufwand: Hängt massiv von der Gruppe ab ... Kann sehr wenig, kann aber auch sehr komplex werden.
191 {{/expandable}}
192
193 Falls alle Rollen vergeben sind, können noch folgende ergänzend dazu kommen.
194
195 * Spielregeln
196 * Frontend (z.B. JavaFX oder Web-Frontends)
197 * Spezielle Rolle für REST, WebSockets und OpenAPI und dafür in der obigen Rolle (OpenAPI, REST und Spring) nur noch Spring
198 * Programmierkonzepte
199 ** z. B. Dependency Injection mit Spring
200 * DB-Zugriff:
201 ** Installation/Überwachung der DB
202 * Spezialisten für verschiedene Teilthemen:
203 ** Netzwerkkommunikation
204 ** Regeln des aktuellen Spiels
205 ** Weitere Frameworks
206 ** GUI
207
208 === Projekttagebuch ===
209
210 Im Projekttagebuch werden kurz und knapp die Ergebnisse der Sprints festgehalten und der Ablauf der Projekte als Ganzes dokumentiert.
211
212 Für jeden Sprint wird hier geschrieben,
213
214 * welche Stories umgesetzt wurden.
215 * wie das Review gelaufen ist.
216 * wie die Retrospektive gelaufen ist und welche Maßnahmen ergriffen worden sind, um Probleme im nächsten Sprint zu reduzieren.
217
218 Außerdem:
219
220 * Wann wurden Meilensteine erreicht
221 * Wann wurden Meilensteine verschoben und (ganz wichtig!) was waren die Gründe dafür
222 * Wann wurden andere wichtige Zwischenziele erreicht
223 * Welche besonderen Dinge hat es gegeben, die wesentlichen Einfluss auf das Projekt oder die Gruppe hatten
224
225 == Wechselnde Aufgaben innerhalb der Gruppe ==
226
227 Diese Aufgaben wechseln wöchentlich:
228
229 * Sitzungsleitung und Moderation
230 ** Leitung der Gruppensitzung (Wichtig!!), Support durch Scrum-Master
231 ** Tagesordnung definieren (vorher)!!
232 ** Ein Moderator ist dafür zuständig, dass die Sitzungen geregelt ablaufen, d.h. insbesondere muss ein Moderator darauf achten, dass die Teilnehmer sich an die Regeln (siehe: [[Spielregeln>>doc:Main.Projektarbeit.WebHome||anchor="HZusammenarbeitundVerhaltensregeln"]]) halten, jeder Sprechzeit bekommt und eine Kommunikation möglich ist, d.h. im Zweifelsfall auch Diskussionen zu unterbrechen. 
233 Hier gibt es weitere Hinweise zu der Aufgabe eines Moderators: [[https:~~/~~/www.openpr.de/news/1231293/Was-sind-die-Aufgaben-eines-Moderators.html >>url:https://www.openpr.de/news/1231293/Was-sind-die-Aufgaben-eines-Moderators.html%C2%A0]]
234 * Protokollführung
235 ** Erstellung eines Protokolls der Gruppensitzung
236 ** Hier reicht i.d.R. ein Ergebnisprotokoll
237 ** Protokolle müssen direkt im Wiki abgelegt sein (nicht als PDF, damit sind die einfacher lesbar)
238 * Zu Beginn jeder Gruppensitzung („Daily Scrum“):
239 ** findet ein kurzes „Briefing“ („Blitzlicht“) statt, in der jede/r berichtet, was sie/er in der letzten Woche für das Projekt getan hat.
240 * Am Ende jeder Sitzung neue Aufgabenverteilung
241 ** Tickets (wer macht was)
242 ** Leitung/Protokoll (Liste!)
243 * Tutor ist nur Berater, leitet keine Sitzungen, kann aber um Rat gefragt werden (und greift (zu Beginn mehr und Ende weniger) ein, wenn es zu sehr „aus dem Ruder läuft“, erlaubt aber auch Fehler …)
244
245 = Gruppenweites Code-Review (Team-Review) =
246
247 {{info}}
248 **Kurzfassung:** Mindestens einmal im Projekt wird ein nicht trivialer Codebereich gemeinsam reviewt. Der Kontext wird vorbereitet, die gesamte Gruppe beteiligt sich am Review, Ergebnisse werden dokumentiert und konkrete Verbesserungsmaßnahmen anschließend nachverfolgt.
249 {{/info}}
250
251 Neben den üblichen Pull-Request-Reviews soll im Projekt mindestens ein **gruppenweites Code Reviews** durchgeführt werden. Dieses dienen nicht primär der Fehlersuche, sondern dem **gemeinsamen Verständnis, der Diskussion von Lösungsansätzen und dem Lernen im Team**.
252
253 {{expandable summary="Detaillierte Anleitung zum Gruppenreview"}}
254 == Ziel des Gruppenreviews ==
255
256 Das gruppenweite Review soll dabei helfen:
257
258 * die **gesamte Codebasis besser zu verstehen**
259 * **Designentscheidungen nachvollziehen und hinterfragen zu können**
260 * voneinander zu lernen (gute Lösungen, typische Probleme)
261 * Wissen im Team zu verteilen (kein „Ein-Personen-Code“)
262
263 Wichtig: Es geht **nicht darum, jemanden zu bewerten**, sondern gemeinsam besseren Code zu entwickeln.
264
265 == Organisation ==
266
267 * Durchführung: **mindestens einmal im Semester**
268 * Dauer: **30–60 Minuten**
269 * Vorstellung von **1–2 ausgewählten Codeausschnitten**
270
271 == Rollen im Review ==
272
273 === Autor:in ===
274
275 * stellt den Code vor
276 * (((
277 erklärt:
278
279 * Ziel und Kontext
280 * wichtige Designentscheidungen
281 * ggf. offene Fragen oder Unsicherheiten
282 )))
283
284 === Gruppe (Reviewer) ===
285
286 * stellt Verständnisfragen
287 * gibt Feedback
288 * diskutiert Alternativen
289
290 === Moderator:in ===
291
292 * achtet auf Zeit und Struktur
293 * sorgt dafür, dass alle beteiligt werden
294 * verhindert Abschweifen
295
296
297
298 == Ablauf eines Gruppenreviews ==
299
300 === 1. Vorbereitung (Autor:in) ===
301
302 * Wählt einen **überschaubaren Codeausschnitt** (keine sehr großen Änderungen)
303 * (((
304 Fokus z. B. auf:
305
306 * interessante Logik
307 * Architekturentscheidungen
308 * schwierige oder unklare Stellen
309 )))
310 * (((
311 Bereitet **2–3 konkrete Fragen** vor, z. B.:
312
313 * „Ist diese Struktur sinnvoll?“
314 * „Wie würdet ihr das testen?“
315 * „Gibt es eine einfachere Lösung?“
316 )))
317
318 === 2. Vorstellung (ca. 5–10 Minuten) ===
319
320 * (((
321 kurzer Überblick:
322
323 * Was macht der Code?
324 * Wo ist er im System eingeordnet?
325 )))
326 * keine detaillierte Zeilen-für-Zeilen-Erklärung
327
328 === 3. Gemeinsames Review (ca. 20–40 Minuten) ===
329
330 Diskussion des Codes anhand folgender Leitfragen:
331
332 ==== Verständlichkeit ====
333
334 * Ist der Code gut nachvollziehbar?
335 * Welche Stellen sind schwer verständlich?
336
337 ==== Design ====
338
339 * Ist die Struktur sinnvoll gewählt?
340 * Gibt es einfachere oder klarere Alternativen?
341
342 ==== Wartbarkeit ====
343
344 * Ist der Code leicht erweiterbar?
345 * Gibt es unnötige Komplexität?
346
347 ==== Testbarkeit ====
348
349 * Wie könnte man den Code testen?
350 * Sind relevante Tests vorhanden oder ableitbar?
351
352 === 4. Fazit (ca. 5 Minuten) ===
353
354 * Was war gut?
355 * Was kann verbessert werden?
356 * Welche Erkenntnisse nehmen wir als Team mit?
357
358 == Geeignete Inhalte für das Gruppenreview ==
359
360 **Gut geeignet:**
361
362 * neue Features mit Designentscheidungen
363 * komplexe Logik oder Algorithmen
364 * Refactorings
365 * Code, bei dem Unsicherheit besteht
366
367 **Weniger geeignet:**
368
369 * sehr kleine oder triviale Änderungen
370 * reine Formatierungsänderungen
371 * sehr große, unstrukturierte Codebereiche
372
373 == Feedback-Regeln ==
374
375 === Gutes Feedback ist: ===
376
377 * konkret („Die Methode ist schwer lesbar, weil …“)
378 * begründet („… dadurch wird der Ablauf schwer nachvollziehbar“)
379 * konstruktiv („Man könnte hier …“)
380
381 === Vermeidet: ===
382
383 * pauschale Aussagen („Das ist schlecht“)
384 * persönliche Kritik
385 * Diskussionen ohne Bezug zum Code
386
387 == Typische Probleme ==
388
389 * **Zu viel Code:** → stärker eingrenzen
390 * **Alle schweigen:** → gezielte Fragen stellen
391 * **Einzelne dominieren:** → Moderator:in steuert aktiv
392 * **Diskussion driftet ab:** → Fokus wieder auf Code lenken
393
394 == Minimal-Regeln ==
395
396 1. Es wird **nur ein überschaubarer Codeausschnitt** betrachtet
397 1. Eine Person stellt den Code vor
398 1. Die Gruppe diskutiert strukturiert
399 1. Am Ende werden **konkrete Erkenntnisse festgehalten**
400
401 == Hinweis ==
402
403 Das Gruppenreview ist eine **Lerngelegenheit**.
404 Bringt gerne auch Code mit, bei dem ihr unsicher seid – genau dort entsteht oft die beste Diskussion.
405
406 Man kann das auch mehrmals machen. Im SWP wird es aber nur einmal verlangt.
407
408 ----
409 {{/expandable}}
410
411 = Siehe auch =
412
413 * [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
414 * [[Glossar>>doc:Main.Glossar.WebHome]]
415 * [[Bewertung>>doc:Main.Bewertung.WebHome]]