Allgemeines zur Dokumentation

Hi.


YMMD 🤣

Ich habe mir angewöhnt alles in ein NetBox System einzuklimpern. Ist anfangs jede Menge Arbeit so eine Doku, egal welches System an der Stelle. Doch die Vorteile liegen auf der Hand und sollten immer der Beweggrund sein, eine Doku zu erstellen.

Gerade, wenn man als zertifiziertes Unternehmen von einem Automobilisten mal in die Verlegenheit kommt in der IT auditiert zu werden, dann will man einfach nicht lange suchen und schnell zu den Infos kommen.

Leider geht das in der Ausbildung sträflich unter. Habe mehrere Praktikanten in die IT bezogenen Fachschulen bei mir gehabt, welche auf eben deine Frage (@TO) keine Antwort hatten oder eben sagten: "Ja, muss gemacht werden, weil wohl wichtig."

Gruß
Marc

Moin

Und wer zu wenig dokumentiert und aus gesundheitlichen Gründen längerfristig ausfällt, "schadet" dem Unternehmen. Von einer effizienten Fehlersuche mal ganz zuschweigen.

Das "gesunde" Mittelmaß ist sinnvoll
Bloß was ist gesund?

Gruß
em-pie

Das ist schon fast philosophisch.

Allerdings sollte ein "Mit-Admin", welcher dieselbe Infrastruktur betreut, auch einigermaßen denselben Stand haben.

Ansonsten ist es ja ein realistisches Szenario, dass ein externer Dienstleister einspringt, falls der hauseigene Admin nicht greifbar ist (Gründe erst einmal nachrangig).
Bei Diesem würde ich jetzt einfach mal voraussetzen, dass Fachwissen in ausreichendem Maß vorhanden ist.

Den Zugang zur Doku würde ich in jedem Fall bei der GF hinterlegen.

Gruß
Marc

Ich denke man muss einen Konsnes finden, was, wie und in wlechem Umfang dokumentiert werden soll. Wir nutzen für 99% der Fälle Tools die onPrem installiert sind und im WorstCase auch autark auf irgendeiner Hardware laufen können.

Die "tiefe" der Dokumentation hängt in den meisten Fallen am Service auf den es ankommt, ERP Dienste sind deutlich genauer und umfangreicher dokumentiert wie ein Printserver, ebenso ist die "Core" Hardware (SAN, VMWare Hosts, Router) genauer dokumentiert wird Edge Hardware, kommt immer auf dem Bedarfsfall an, einen roten Faden "das muss alles dokumentiert sein" gibt es so nicht, jeder hat andere Anforderungen.

Allerdings: lediglich die wichtigsten Admin-Kennwörter liegen auf "Papier" vor, in einem Tresor der GF, wird alle 6 Monat überprüft (versiegelter Umschlag) und ggf. erneuert. Der Rest ist nur Digital.

@117471 : 2-schneidges Schwert, wer zu wenig dokumentiert wird permanent, auch im Urlaub angerufen wenn etwas nicht geht - ich bin froh, dass wir mittlerweile einen recht guten Dokumentationsstand haben und ich im Urlaub nicht mehr angerufen werden, es sei denn, es fällt in meinem direkten Wirkungsbereich und ist etwas spezielles (sehr selten mittlerweile).

Moin,

Systemhäuser dokumentieren so genau, weil sie es müssen. Laut IHK (egal ob Abschlussprüfung oder Operativer Professional) gehört eine Dokumentation zu einem Projekt. Bei der Abschlussprüfung zum Fisi ist die Dokumentation mit 20 bis 25 % Zeit angesetzt. Bei einem einwöchigen Projekt, ist also 1 Tag für die Dokumentation vorgesehen. Warum ist dem so? Damit du nachweisen kannst, dass der Anforderungskatalog des Projektes umgesetzt wurde, denn nur wenn alle zehn Anforderungen erfüllt sind, kann ich als Systemhaus alle 10 Anforderungen abrechnen. Und ja, je länger das Projekt wird, desto länger wird ggf. die Dokumentation, wobei das Verhältnis dann von den 20% bis 25 % abweichen kann.

Das ist (aus meiner Erfahrung) ein Grund wieso Systemhäuser das machen. Der andere Grund ist: Sie wollen nicht noch dauernd irgendwelche Fragen haben, sondern sich anschließend dem nächsten Projekt widmen.

Das liegt dann leider oft an den Unternehmen. Wenn in der Abschlussprüfung eine Dokumentation erwähnt ist (was sie laut Prüfungsordnung sein muss), dann ist die Frage was und warum dokumentiert wurde als Prüfer legitim und einer meiner Kollegen stellt die Frage in jeder zweiten Prüfung. Vielen Prüflingen ist allerdings nicht mal bekannt, dass der Zeitfaktor "Dokumentation der Prüfung" die Kundendokumentation beinhaltet. Der Großteil meint, damit sei ihre eigene Dokumentation für die IHK gemeint, was definitiv nicht der fall ist.

Langer Anlauf zur Frage:
Ich persönlich orientiere mich an den obigen Punkten.
Alles was ansatzweise einem Projekt nahe kommt wird dokumentiert und auf einem dafür bereitgestellten Ordner abgelegt. Beispiele: Einbau neues Bandlaufwerk, Umbau Firewall, Installation neuer Monitoring-Software, etc. Die hier dokumentierten Fakten sind oft statisch und ändern sich recht selten. Zum Beispiel die Startreihenfolge der VMs ändert sich dann doch eher selten.

Alles was dann eher in den Bereich "Linienaufgabe" fällt, also täglich gemacht wird und/oder sich in dynamischen Prozessen verändern kann, wird nicht dokumentiert, sondern mit den Kollegen kommuniziert. Dazu gehört dann zum Beispiel: Änderung von Backup-Zeiten, Benutzerberechtigungen via Gruppen, Zugriffsrechte auf andere Postfächer.
Wenn der Kollege zum Beispiel nicht in der Lage ist die Vertreterregeln im Exchange zu finden, dann hat er da nichts zu suchen. Wenn der Kollege nicht erkennt, dass das Backup fehlgeschlagen ist, weil die Sperrfrist am Bandlaufwerk noch nicht abgelaufen ist, dann soll er da nicht dran rumfummeln, sondern anrufen. Das sind Dinge, die sich durchweg häufig ändern können.

Es nützt deinem Mit-Admin sicherlich auch nichts wenn du nur noch Dokumentierst und nicht mehr administrierst

Gruß
Doskias

Moin.

@Doskias schrieb

Musste die Erfahrung machen, dass dem nicht immer so ist. Beispielsweise arbeitet ein Systemhaus kompetent und zuverlässig, auch ist es während der Supportzeiten gut erreichbar. Aber auf Rückfragen gibt man sich sehr zugeknöpft, beantwortet gern Fragen, die nicht gestellt wurden und rückt gezielt angefragte genauere Angaben nur ungern heraus. Da braucht man viel Geduld.
Ausführlich ist allenfalls der Wartungsvertrag.

Gruß
JoeToe

Das möchte ich abstreiten. Selbst privat dokumentiere ich inzwischen recht konsequent, zumindest dichter als ich das in manchen Unternehmen vorfinde. Gerade in einer Doppelrolle ist es schlicht unmöglich sich zu merken, wie der ganze Kram funktioniert. Der Unternehmer kann es sich zeitlich auch nicht leisten, alle 18 Monate dieselben Fragen zu googeln, während es den angestellten Admins meist egal ist, zumal wenn andere Admins diesen Zeiteinsatz wiederholen.

Grüße
Richard

Moin,

eine Dokumentation ist so zu gestalten, dass ein fachkundiger Dritter sich innerhalb kurzer Zeit einarbeiten kann. Nicht mehr und nicht weniger. Die Haltung: "Wer zuviel dokumentiert, macht sich ersetzbar." ist nur insofern korrekt, als dass es genau darum beim Dokumentieren geht. Man muss im Unglücksfall ersetzbar sein. Es ist ziemlich egoistisch, das nicht zulassen zu wollen. Passiert einem mal was, steht gleich der ganze Betrieb still.

In die Doku gehört also jede Information, die wichtig ist, um den Betrieb am Laufen zu halten. Das fängt mit der (virtuellen) Hardware der Server an, geht über das eingesetzte Betriebssystem mit dokumentiertem Patchstand, den installierten Rollen, Feautures (oder vielleicht auch Services und Module ), deren Konfiguration usw. bis hin zur Dokumentation des Troubleshottings. Man kann nicht zu viel dokumentieren und dokumentiert immer zu wenig.

Eine gute Doku dient dem Wissenstransfer im Team und über die Zeit. Je größer Teams werden, desto spezialisierter werden die Aufgaben. Trotzdem sollte jeder im Team immer "wissen", was die anderen so machen. Da das aber so einfach nicht ist, legt man dieses Wissen in einer Doku ab, so dass jeder zumindest nachschlagen kann. Und über die Zeit deshalb, weil in einer guten Doku auch steht, was wie zu machen ist. Das fängt mit Nomenklaturen an und hört mit Installationsanweisungen auf. Letzters können dann auch Verweise nach außen sein.

Ich selbst bevorzuge Wikis. In meiner alten Firma wurde Confluence benutzt. Das ist richtig gut. In meiner neuen Firma musste ich feststellen, dass es keine ordentliche zentrale Doku gibt. Also auch Confluence ... Nein. Ich will weder in die Cloud mit meiner Doku noch so einen unverschämten Preis für die on-premise Version zahlen. Ich baue das jetzt mit wikimedia auf. Das funktioniert richtig gut. Ich mag vor allem deshalb Wikis, weil man über vernetzte Kategorien verschiedene Zugangswege schaffen kann. So gibt es die Kategorie "Server", in der alle sind, dann die Kategorien der Funktionen der Server, dann Sachkategorien usw. Und jeder Server ist in zwei bis vier Kategorien.

Das Wiki steht im internen Netz und ist so von jeder Arbeitsstation erreichbar, so dass man auch vor Ort darauf zugreifen kann und so nachlesen kann, was vor Ort Sache ist und auch gleich Änderungen dokumentiert. Die Dokumentation muss immer auf dem Laufenden sein. Ich persönlich habe die Doku immer auf, wenn ich irgendwas mache.

Kurz: Die Zeit, die man auf eine gute Doku verwendet, kriegt man an anderer Stelle mehr als zurück.

my 2 cents

Erik

Zum "Wer dokumentiert macht sich selbst ersetzbar" könnte man anmerken: Es kommt auch auf das WIE an. Ich mache z.B. viele Dokumentation in meiner Software - die daraus aber auch wieder automatisch Aufgaben für mich erledigt (z.B. mit den Daten aus dem Inventory hat man gleich die Möglichkeit zu prüfen ob Geräte da sind, DHCP-Server zu füttern,...). In sofern macht meine Dokumentation natürlich teile meines Jobs "ersetzbar" - was mir aber die Zeit gibt sinnvollere Dinge zu tun. Und Ersetzbar in sofern nicht das ja eben die Software auch jemand programmieren muss (wobei - bevor jetzt hier die ersten schreien das man ja dann auch wieder ne Abhänigkeit erschafft -> natürlich kann man auch problemlos die Daten exportieren, dann hat man auch z.B. das Inventory, muss dann halt die Tests wieder von Hand machen usw...)

Ist halt immer eine Frage des "Wie" - ich für mich habe halt entschieden sowas in ne Software zu packen die dann bei Bedarf die Doku in div. Formaten ausspucken kann. So hat der Betrieb immer die Möglichkeit wenn ich mal gehen sollte - und ich kann gleichzeitig mir meinen Tag von "Standard-Krams" grossteils freihalten.

Hallo,


Stimmt - ich habe damals extra aramäisch und altgriechisch gelernt. Das ist viel besser als PGP

Gruß,
Jörg