Inhalt einer Admindokumentation

[Tratek]

Schreibe gerade für mein Abschlussprojekt die Admindokumentation und wollte mal fragen, was inhaltlich alles da rein soll...

Bisheriger Inhalt der Admindoku:

• Vergebene Passwörter
• Vergebene IP-Adress-Konfigurationen
• Screenshots von einigen Konfigurationen
• Auflistung der installierten Programme
• Ansprechpartner des Projektes => intern und beim Kunden
• Verweise auf weitere interne Dokumentationen => z.B. Best Practice
• erworbene Hardware => Spezifikationen, Ansprechpartner für Service
• Lizenzen
• virtualisierte Maschinen und deren Kapazitäten
• Zertifikate => z.B. SSL-Zertifikate und Dateipfad wo sie hinterlegt wurden

Habe ich wichtige Punkte vergessen und gibt es möglicherweise gute Beispieldokumentationen, die man als Vorlage benutzen könnte ?

 

[Maniska]

Achtung: Persönliche Meinung inc.!!!

In eine Admindoku gehört all das rein, was jemand Berechtigtes (!!!) benötigt um das System zu administrieren.

vor 51 Minuten schrieb Tratek:

• Vergebene Passwörter
• Vergebene IP-Adress-Konfigurationen
• Lizenzen
• Zertifikate => z.B. SSL-Zertifikate und Dateipfad wo sie hinterlegt wurden

Da gehört nur in die Doku wo man sie finden kann, bzw der Namen des Serviceusers (service-print.contoso.local) oder des Zertifikates "mail.x.y " oder "Wildcard".

Das Dokument nimmt der ein oder andere IT Leiter auch mal gerne mit in Meetings mit nicht berechtigten Personen oder es wird an den DL geschickt oder... Nenene da gehört nix rein was Schaden verursachen könnte.

vor 51 Minuten schrieb Tratek:

• Screenshots von einigen Konfigurationen
• Auflistung der installierten Programme
• Ansprechpartner des Projektes => intern und beim Kunden
• Verweise auf weitere interne Dokumentationen => z.B. Best Practice
• erworbene Hardware => Spezifikationen, Ansprechpartner für Service
• virtualisierte Maschinen und deren Kapazitäten

Kann man mit rein nehmen, aber mal ehrlich, wer pflegt die Doku nach wenn die VM angepasst, der DL geändert oder ein neues Programm installiert wird? Das kann man in die Installationsdoku packen, aber die ist wie ein Neuwagen: je älter desto weniger wert.

[Gast Interrupt]

vor 48 Minuten schrieb Maniska:

Kann man mit rein nehmen, aber mal ehrlich, wer pflegt die Doku nach wenn die VM angepasst, der DL geändert oder ein neues Programm installiert wird? Das kann man in die Installationsdoku packen, aber die ist wie ein Neuwagen: je älter desto weniger wert.

Indem man das einfach beim Change Managment in den Workflows festlegt, dass jeder, der Änderungen an einem Server durchführt, auch die Dokumentation entsprechend anpassen muss. Gut, eine Auflistung an installierter Software würde ich beispielsweise nicht dokumentieren, da dies übertrieben ist (außer die Rolle des Servers ändert sich, wenn eine andere Software zusätzlich installiert wird).

Aber ansonsten halte ich solche Informationen schon sehr nützlich und wichtig und müssen aktuell gehalten werden. Damit die Dokumentation oder ein anderer Arbeitsschritt nicht vergessen wird, haben wir Checklisten eingeführt, die in das Ticketsystem gepostet wird. Das funktioniert sehr gut.

// Edit:

Passwörter und andere kritische Informationen gehören nicht in die Dokumentation sondern in einem Passwort Manager. In der Dokumentation wird dann lediglich ein Verweiß auf den Ordner im Passwort Manager hinzugefügt.

In einer IT-Dokumentation würde ich außerdem ein Netzplan hinzufügen. 

Bearbeitet 25. April 2022 von Interrupt

[Tratek]

Hab nen extra Subnetz für den Virtualisierungs-, Datenbank und Webserver. Die anderen Netze, die an der Firewall hängen sind eher irrelevant. Reicht nicht ein Verweis auf einen Netzplan z.B. auf interne Dokumente ? Also z.B. interne Admindokus für andere Projekte ?