- 1 Abschnitt
- 8 Lektionen
- 2 Hours
alles ausklappenalles einklappen
Aufgaben
Aufgabe 1: Grundlagen der Dokumentation
- Theoretische Fragen:
- Erkläre die Bedeutung der Dokumentation in IT-Projekten.
- Nenne und beschreibe die verschiedenen Arten der Dokumentation.
- Warum ist es wichtig, Dokumentation regelmäßig zu aktualisieren?
Aufgabe 2: Anforderungsanalyse-Dokumentation
- Praktische Aufgabe:
- Erstelle eine Anforderungsdokumentation für ein fiktives Projekt: die Entwicklung einer mobilen App zur Verwaltung persönlicher Finanzen.
- Beschreibe die funktionalen und nicht-funktionalen Anforderungen.
- Füge eine Priorisierung der Anforderungen hinzu.
Aufgabe 3: Systemarchitektur-Dokumentation
- Diagrammerstellung:
- Erstelle ein Architekturdiagramm für ein einfaches Webanwendungssystem, das aus einem Frontend, Backend und einer Datenbank besteht.
- Nutze ein Tool wie draw.io oder Lucidchart.
- Beschreibe die Interaktionen zwischen den Komponenten.
Aufgabe 4: Benutzerdokumentation
- Erstellung eines Benutzerhandbuchs:
- Schreibe ein Benutzerhandbuch für die fiktive Finanzverwaltungs-App aus Aufgabe 2.
- Füge Screenshots und Schritt-für-Schritt-Anleitungen hinzu, wie man ein neues Konto erstellt, Ausgaben einträgt und Berichte generiert.
Aufgabe 5: Entwicklerinformationen
- Quellcodedokumentation:
- Kommentiere ein einfaches Java-Programm zur Addition von zwei Zahlen (siehe unten), um die Funktionsweise des Codes zu erklären.
public class Addition {
// Diese Methode addiert zwei ganze Zahlen und gibt das Ergebnis zurück
public static int add(int a, int b) {
int result = a + b;
return result;
}
public static void main(String[] args) {
// Zwei Beispielzahlen
int number1 = 5;
int number2 = 7;
// Aufruf der Additionsmethode und Ausgabe des Ergebnisses
int sum = add(number1, number2);
System.out.println("Die Summe von " + number1 + " und " + number2 + " ist: " + sum);
}
}
Aufgabe 6: Dokumentationsreview
- Review und Feedback:
- Wähle eine bestehende technische Dokumentation (z.B. eine öffentlich zugängliche API-Dokumentation).
- Führe eine Überprüfung durch und identifiziere mindestens drei Bereiche, die verbessert werden könnten.
- Schreibe Verbesserungsvorschläge und begründe diese.
Aufgabe 7: Pflege und Aktualisierung der Dokumentation
- Versionskontrolle:
- Erstelle ein kurzes Konzept, wie du die Dokumentation eines Projekts mithilfe eines Versionskontrollsystems (z.B. Git) verwalten würdest.
- Beschreibe, wie du Änderungen nachverfolgst und regelmäßige Überprüfungen sicherstellst.
