Dokumentation ist alles

August 22, 2018 in network ‐ 2 min read

Ab einer bestimmten Firmen- oder Projektgröße ist eine saubere Dokumentation unglaublich wichtig. Ich finde ehrlich gesagt, dass auch Kleinstprojekte sauber dokumentiert gehören, will dieses Fass jetzt aber nicht aufmachen.

Wenn es keine gut organisierte Dokumentation gibt, kommt es zu vielen Problemen: - Arbeitszeit wird “verbrannt” durch Suchen von Informationen - Passwörter verschwinden, daraus erwachsen Folgeprobleme - Personen sammeln Herrschaftswissen an (“Ja das musst du halt wissen in dem Netz”) - Neue Kollegen können sich nicht selbst einlernen - usw.

Ich könnte diese Liste noch wesentlich länger werden lassen. Der offensichtlichen Grund sich Dinge aufzuschreiben ist die menschliche Vergesslichkeit. Dennoch kommen die meisten Probleme eher daher, dass mehr als eine Person mit Planung, Ausbau, Wartung und Fehlersuche innerhalb einer Umgebung betraut sind. Wenn Änderungen nicht sofort und vollständig dokumentiert werden, können die anderen beteiligten Personen sich nicht mehr auf die Ihnen vorliegenden Informationen verlassen. Das wird definitiv zu Problemen führen.

Eine gute Dokumentation sollte den Anspruch haben, dass eine Person die nicht mit dem dokumentierten Sachverhalt vertraut ist: - Schnell einen Überblick über die Gesamtsituation erhält - Die Daten in strukturierter und durchsuchbarer Form vorfindet - An nur einem Ort suchen muss

image

Was vermieden werden sollte: - Verschiedene Dateien in denen gesucht werden muss wie Version_vor_2016, Netzplan_alt, siehe Dokumentation XY - Veraltete Daten z.b. ein nicht dokumentierter Ansprechpartnerwechsel - Inkorrekte Daten wie falsche Modellnummern bei Geräten. Schreibt lieber nichts auf, wenn Ihr euch nicht sicher seid!

image

Eine Dokumentation sollte Mindestens aus folgenden Teilen bestehen: - Textdokumentation - Netzwerkplan - Gesamtdokumentation

Gut wären auch folgende weitere Komponenten: - Hardware Inventarliste - Software (Lizenz) Inventarliste - Klar definierte On- und Offboardingprozesse

Cheers, Ori