Wie die Dokumentation zur Netzwerkautomatisierung erstellen?

Die Netzwerkautomatisierung kann Netzwerkteams helfen, Zeit zu sparen. Doch wenn das Projekt nicht ausreichend dokumentiert ist, kann Netzwerkautomatisierung auch zur Katastrophe werden.

Eine korrekte Dokumentation von Netzwerken erfordert einige wenige Punkte, damit Teams den größten Nutzen daraus ziehen können.

1. Hohes Verständnis für manuelle und automatisierte Prozesse. Netzwerkteams sollten einen umfassenden Überblick über den manuellen Prozess haben, den die Automatisierung ersetzen wird. Dieser Überblick bringt Sie zum Kernziel der Netzwerkautomatisierung. Jede größere Änderung, die einen manuellen Prozess verändern könnte, würde auch Änderungen im automatisierten Prozess erfordern. Netzwerkteams sollten die Dokumentation der Netzwerkautomatisierung wieder auf die manuellen Schritte zurückführen.

2. Detaillierte Dokumentationsproben. Teams sollten Code- oder Konfigurationsproben mit detaillierten Hinweisen zum Was und Warum des Prozesses zur Verfügung stellen. Wenn die Dokumentation eine Überprüfung erfordert, bedeutet dies wahrscheinlich eine der folgenden Maßnahmen:

• Der automatisierte Prozess ist unterbrochen.
• Eine Änderung im Netzwerk erfordert eine Änderung der manuellen und automatisierten Prozesse.
• Ein auftretendes Hinzufügen erfordert eine Änderung der manuellen und automatisierten Prozesse.

In allen drei Situationen wird der für Hinzufügungen und Änderungen zuständige Automatisierungsingenieur wahrscheinlich mehr von Code-Proben profitieren als von generischen Erklärungen der automatisierten Aufgaben.

3. Konsistentes Vokabular in allen Dokumenten. Die IT-Teams sollten sicherstellen, dass die gesamte Dokumentation von Netzwerken die gleiche Terminologie und Nomenklatur verwendet, um Prozesse, Komponenten und Aufgaben zu beschreiben, die die Automatisierungskonfigurationen ersetzen. Bei Bedarf können Netzwerkteams ein Glossar für die Automatisierungsdokumentation erstellen, das alle verwendeten Begriffe und Definitionen auflistet. Die Teams sollten auch dieses Dokument pflegen.

4. Leicht zugängliche Netzwerkdokumentation. Schließlich sollten die Netzwerkteams sicherstellen, dass die gesamte Dokumentation zur Netzwerkautomatisierung zentralisiert, zugänglich und bearbeitbar ist für diejenigen, die die Dokumentation benötigen. Wenn ein Benutzer Änderungen oder Ergänzungen vornimmt, sollten die Teams die Dokumentation aktualisieren und auf ihre Richtigkeit überprüfen.

Der beste Weg, diese Zugänglichkeit zu erreichen, sind Tools für Enterprise Change Control Management. Diese Tools können dazu beitragen, dass die Dokumentation regelmäßig aktualisiert wird.