EMZETT.
Login

Emzett Wiki

IT-Dokumentation und Netzwerkdokumentation: damit andere durchblicken

Properties1
tagsglossar, it-betrieb, dokumentation

2 Min. Lesezeit

IT-Dokumentation und Netzwerkdokumentation: damit andere durchblicken

Kurz: Gute IT-Dokumentation hält Netzplan, Adressen, Konfigurationen, Zugänge und Abläufe aktuell fest, damit Störungen schneller gelöst und Vertretungen möglich werden.

Genauer: „Das weiß nur Max“ ist ein Risiko. Dokumentation spart im Ernstfall Stunden, erleichtert Einarbeitung, Audits und Übergaben. Sie muss aktuell, auffindbar und geschützt sein.

Im Detail

Was dokumentiert wird

  • Netzplan (logisch: Subnetze/VLANs/Router/Firewall; physisch: Standorte, Racks, Patchfelder, Dosen).
  • IP-Adressplan (Bereiche, statische Adressen, DHCP-Pools, DNS-Namen).
  • Geräte/Inventar (Seriennummer, Standort, Verantwortliche).
  • Konfigurationen (Router/Switch/Firewall-Exports, Server-Rollen, Versionen), Abhängigkeiten.
  • Zugänge (im Passwortmanager/Tresor, nicht im Wiki-Klartext).
  • Abläufe/Runbooks (Backup, Restore, Neuinstallation, Notfall).
  • Änderungen (Changelog), Verträge/SLAs/Lizenzen, Ansprechpartner.

Werkzeuge und Form

  • Diagramme: draw.io/diagrams.net, Visio, Excalidraw, Mermaid/PlantUML (Diagramme als Code, versionierbar).
  • Wiki/Knowledge Base: Confluence, BookStack, Wiki.js, Obsidian, Markdown im Git-Repo (Docs-as-Code).
  • Netzwerk-Tools: NetBox (IPAM/DCIM), phpIPAM; automatisch erzeugte Doku (Exports, Ansible-Fakten).
  • Standards: einheitliche Benennung (z. B. sw-bk-01), Vorlagen, Versionsstände/Datum, Verantwortlicher je Dokument.
  • Aktualität: Dokumentation Teil der Aufgabe (Change → Doku), regelmäßige Reviews; veraltete Doku ist gefährlich.

Gute Praxis

  • Zielgruppe beachten: Einsteiger-Leitfaden vs. Detailreferenz.
  • Kurz, präzise, mit Screenshots/Diagrammen, Beispiele und Befehle.
  • Entscheidungen begründen (Warum so?).
  • Zugriffsrechte: nicht jeder muss alles sehen; Netzpläne und Zugangsdaten sind sensibel (Angriffsplan!).
  • Backup der Doku (nicht nur im System, das ausfällt; Notfall-Ausdruck/Offline-Kopie).
  • Testen: Kann jemand anderes nach der Doku die Aufgabe lösen?
  • Für Projekte/Abschlussprüfung: Doku mit Soll-/Ist-Analyse, Netzplan, Konzept, Tests, Übergabe.

Beispiel: Mini-Netzdoku für ein Heim-/Büronetz

  1. Diagramm: Internet → Router/Firewall (192.168.1.1) → Switch → Clients/NAS/Drucker; WLAN-SSIDs (Gast getrennt).
  2. Tabelle: Gerät, IP, MAC, Standort, Zweck.
  3. DHCP-Bereich 192.168.1.100–199, feste IPs .10–.50.
  4. Zugänge im Passwortmanager (Router-Admin, WLAN, NAS).
  5. Notfall: Router zurücksetzen, Konfig-Backup-Datei (Datum), Provider-Hotline.
  6. Änderungsprotokoll mit Datum. So wird auch ein Wechsel (neuer Router, neuer Admin) schmerzlos. Siehe Netzplan, Verkabelungsplan, Inventar.

Siehe auch: Netzplan und Gantt, Verkabelungsplan, IT-Asset-Management

Backlinks