Netzwerk Grundlagen

Die zu erstellende Netzwerkdokumentation ist als technische Dokumentation für Systemadministratorinnen und Administratoren bzw. Entwickler zu gestalten.
Entsprechend müssen Fachbegriffe und Konzepte nicht erklärt werden. Die Dokumentation soll dabei so umfangereich sein, dass ein fachkundiger Administrator alle Informationen vorfindet um am System weiterarbeiten zu können.

Wenn sich ein Administrator bereits mit einem System vertraut gemacht hat und zu einem späteren Zeitpunkt wieder damit arbeiten muß kann ein Change-Log sehr hilfreich sein. Dadurch wird der Administrator in die Lage versetzt nicht das ganze Dokument nochmals lesen zu müssen sondern sich nur die geänderten Bereiche anzusehen.
Das Change-Log sollte eine Versionsnummer mitführen welche auch im Dokument ersichtlich ist, das Datum der Änderung und natürlich eine kurze Beschreibung. Es reicht dabei ein verweis z.b. auf die Kapitelüberschrift im Dokument welche sich geändert hat. Ein Hinweis ob es sich dabei um eine Änderung oder einen neuen Eintrag handelt wäre ebenfalls empfehlenswert.

Die Dokumentation soll als einzelnes Dokument zur Verfügung stehen. Verwenden Sie bei der Übermittlung bitte PDF als Dokumentenformat. Damit ist neben dem Schreibschutz auch eine einheitliche Darstellung auf allen Endgeräten gegeben.
Verwenden Sie zur Veranschaulichung auch gerne Bilder und Screenshots. Bedenken Sie dabei jedoch, dass ein Administrator auch im Dokument suchen können muss und dass daher sämtliche relevanten Informationen (auch) als Text vorhanden sind.
Lesen Sie sich den Artikel https://www.techsmith.de/blog/gute-technische-dokumentation-erstellen/ durch um weitere Tipps für eine gute Dokumentation zu erhalten. Strukturieren Sie die Dokumentation übersichtlich. Handbücher zu lesen macht kaum jemandem Spaß, machen Sie es demjenigen also nicht noch mühsamer ;-)

Die technische Dokumentation ist auch ein geeigneter Platz um an zentraler Stelle aufgetretene Probleme und deren Lösung zu dokumentieren. Sollten Sie im laufe des Projektes auf ein Problem stoßen, dokumentieren Sie es hier. Sobald das Problem behoben ist, dokumentieren Sie auch (kurz) die Lösung.