Dies ist ein maschinell übersetzter Text, der Fehler enthalten kann!
Gute Dokumentation ist der Unterschied zwischen dem Erinnern, wie Dinge funktionieren, und dem Feststecken um 23 Uhr an einem Sonntag, weil der Server ausgefallen ist und sich niemand daran erinnert, wie er eingerichtet wurde. Dokumentation ist vielleicht nicht der aufregendste Teil des IT-Betriebs, aber es ist einer der wichtigsten.
Warum dokumentieren?
| Grund | Erklärung |
|---|---|
| Gedächtnis | Du wirst dich in sechs Monaten nicht an alles erinnern, und das musst du auch nicht |
| Zusammenarbeit | Andere müssen verstehen können, was du getan hast, ohne dich zu fragen |
| Fehlersuche | Wenn etwas schief geht, ist es unschätzbar wertvoll zu wissen, was normal ist |
| Wiederaufbau | Wenn ein Server ausfällt, musst du genau wissen, wie er eingerichtet war |
| Nachvollziehbarkeit | Was wurde geändert, wann und von wem? |
Skriv die Dokumentation für “dich in der Zukunft”
Die beste Faustregel: Schreibe so, als würdest du es dir selbst in sechs Monaten erklären. So stellst du sicher, dass du genügend Details einbeziehst, ohne die Dinge zu verkomplizieren.
Arten der Dokumentation im IT-Betrieb
Netzwerkdiagramm
Ein Netzwerkdiagramm zeigt die physische und/oder logische Struktur des Netzwerks. Es kann von einer einfachen Skizze bis zu einem detaillierten Diagramm mit VLANs, IP-Adressen und Firewall-Regeln reichen.
Ein gutes Netzwerkdiagramm sollte Folgendes enthalten:
- Alle Netzwerkgeräte (Switches, Router, Firewalls, Access Points)
- VLAN-Struktur mit Subnetz
- IP-Adressen für wichtige Geräte (Server, Gateway)
- Verbindungen zwischen Geräten
IP-Plan
Ein IP-Plan ist eine Übersicht darüber, wie IP-Adressen im Netzwerk verteilt sind. Er hilft Ihnen, Ordnung zu halten und Konflikte zu vermeiden (zwei Geräte mit derselben Adresse).
Beispiel:
| VLAN | Name | Subnetz | Gateway | DHCP-Bereich | Hinweise |
|---|---|---|---|---|---|
| 10 | Administration | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | Begrenzter Zugriff |
| 20 | Mitarbeiter | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | Schüler | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | Nur Internet |
| 50 | Server | 10.0.50.0/24 | 10.0.50.1 | Keine (statisch) | Feste IP-Adressen |
Statische Adressen:
| IP-Adresse | Gerät | Rolle |
|---|---|---|
10.0.50.10 | web-01 | Nginx |
10.0.50.11 | db-01 | PostgreSQL |
10.0.50.12 | monitoring-01 | Grafana + Loki |
10.0.50.20 | proxmox | Hypervisor |
Checklisten
Checklisten stellen sicher, dass nichts vergessen wird. Sie sind besonders nützlich für Aufgaben, die Sie seltener ausführen, wie z. B. das Einrichten eines neuen Servers oder die Durchführung einer Sicherheitsüberprüfung.
Beispiel: Checkliste für neuen Linux-Server:
- Betriebssystem installieren (Debian/Ubuntu)
- Alle Pakete aktualisieren (
sudo apt update && sudo apt upgrade) - Benutzer mit sudo-Zugriff erstellen
- Root-Login über SSH deaktivieren
- Firewall konfigurieren (
ufw) - Notwendige Software installieren
- Backup einrichten
- Server im IP-Plan dokumentieren
- Testen, ob der Dienst funktioniert
Änderungsdokumentation
Jedes Mal, wenn Sie eine Änderung in einer Produktionsumgebung (Server, Netzwerk, Dienst) vornehmen, sollten Sie diese dokumentieren. Ein einfaches Protokoll kann ausreichend sein:
## Endringslogg
### 2026-04-14 - Oppgradert Nginx
- **Was:** Aktualisiert Nginx von 1.24 auf 1.26
- **Warum:** Sicherheitsupdate (CVE-2025-XXXX)
- **Wer:** Ola
- **Ergebnis:** OK, keine Ausfallzeit
### 2026-04-10 - Neues VLAN für IoT
- **Was:** Erstellt VLAN 40 für IoT-Geräte
- **Warum:** IoT vom Rest des Netzwerks isolieren
- **Wer:** Kari
- **Ergebnis:** OK, alle Drucker zu VLAN 40 verschoben
Bruk Git!
Wenn Sie die Dokumentation in Markdown-Dateien schreiben (empfohlen), können Sie diese mit Git unter Versionskontrolle stellen. Dann haben Sie automatisch eine Historie aller Änderungen und können sehen, wer was und wann geändert hat.
Betriebsdokumentation
Betriebsdokumentation beschreibt, wie ein System in seinem aktuellen Zustand funktioniert:
| Was | Beispiel |
|---|---|
| Systemarchitektur | “Wir betreiben Proxmox mit 3 VMs: web, db, monitoring” |
| Zugangsinfo | “SSH über Port 22, nur von VPN” |
| Backup-Routinen | “Tägliches Backup um 02:00 auf externe Festplatte” |
| Kontaktinformation | “Bei Problemen, kontaktieren Sie Ola (admin)” |
| Wiederherstellungsschritte | “Neustart mit: sudo systemctl restart nginx“ |
Werkzeuge für die Dokumentation
| Werkzeug | Wofür es verwendet wird | Vorteile |
|---|---|---|
| Markdown | Text mit einfacher Formatierung | Leicht, portabel, funktioniert mit Git |
| draw.io | Diagramme und Netzwerkkarten | Kostenlos, visuell, exportiert zu Bild |
| Obsidian | Notiz-App mit Markdown und Verlinkung | Gut für persönliche Wissensbasis |
| MkDocs | Veröffentlichen von Markdown als Webseite | Professionelle Dokumentation |
| Git/GitHub | Versionskontrolle der Dokumentation | Historie, Zusammenarbeit, Backup |
Aufgabe 1 – Erstellen Sie eine einfache Netzwerkkartierung
Verwenden Sie draw.io (kostenlos), um das Netzwerk zu Hause oder in der Schule zu zeichnen:
- Beginnen Sie mit der Internetverbindung und dem Router
- Fügen Sie Switches und Access Points hinzu
- Zeichnen Sie Server, PCs und andere Geräte ein
- Schreiben Sie IP-Adressen dort auf, wo Sie diese kennen
Es muss nicht perfekt sein. Der Punkt ist, visuell über das Netzwerk nachzudenken.
Aufgabe 2 - Erstelle deine eigene Checkliste
Denke an etwas, das du regelmäßig mit IT machst (z.B. eine neue VM einrichten, eine Entwicklungsumgebung installieren oder VS Code konfigurieren). Schreibe eine Checkliste für den Prozess:
- Was sind alle Schritte?
- Was vergisst du am häufigsten?
- Kannst du einige Schritte vereinfachen?
Speichere sie in einem Markdown-Dokument, damit du sie beim nächsten Mal verwenden kannst.
Aufgabe 3 – Dokumentieren Sie einen Ihrer Dienste
Wählen Sie einen Dienst aus, den Sie eingerichtet haben (eine VM, einen Docker-Container, einen Webserver) und schreiben Sie eine kurze Betriebsdokumentation:
- Was macht der Dienst?
- Wie starten/stoppen Sie ihn?
- Was ist die IP-Adresse und der Port?
- Gibt es ein Backup?
Schreiben Sie dies in Markdown und legen Sie es in ein Git-Repository.
Zusammenfassung
- Dokumente für dein zukünftiges Ich: Schreibe, als würdest du es jemandem erklären, der nichts weiß.
- Netzwerkdiagramme und IP-Pläne geben einen Überblick über die Infrastruktur.
- Checklisten stellen sicher, dass bei wiederholten Aufgaben nichts vergessen wird.
- Änderungsprotokolle verfolgen, was wann und von wem gemacht wurde.
- Betriebsdokumentation beschreibt, wie die Systeme heute funktionieren.
- Verwende Markdown + Git für eine einfache, versionskontrollierte Dokumentation.