Modern System Administration

Kapitel 9. Dokumentation

Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: [e-mail]

Es waren die Anfänge meines ersten Sysadmin-Jobs, und alles fühlte sich so neu an. Jeder Schritt, den ich tat, war für die Verfügbarkeit und Leistung des Systems entscheidend. All die auswendig gelernten Sysadmin-Aufgaben, die ich schnell in einem Buch nachgelesen hatte, sagten mir nicht, wann ich bestimmte Befehle mit Root-Rechten verwenden sollte. Zum Glück hatten erfahrene Sysadmins eine Kultur des Wissensaustauschs entwickelt. Unsere Dokumentseite war ein Wiki mit einem Thema, das von dem Cheapass Games Kartenspiel "Give Me the Brain" (GMTB) abgeleitet war. Das Spielprinzip von GMTB bestand darin, dass du als Zombie in einem Fastfood-Restaurant arbeitest und nur ein Gehirn zum Weitergeben hast. Es konnte immer nur eine Person "das Gehirn haben". Die Verknüpfung der Dokumentation mit diesem Spiel verankerte die Verhaltensweisen, die vom Team erwartet wurden, vor allem mit der Vorstellung, dass deine Dokumentation dein zukünftiges Zombie-Ich um 2 Uhr morgens auf den Erfolg bei einem Zwischenfall vorbereiten würde.

In diesem Kapitel möchte ich dir helfen, über Dokumentation nachzudenken. Ich möchte, dass du dich befähigt fühlst, die Praktiken anzuwenden, die eine qualitativ hochwertige Dokumentation unterstützen, die genau, verfügbar, zugänglich, organisiert und wartbar ist, denn die Dokumentation ist Teil des Systems. ...