Das Betriebshandbuch für drei Uhr morgens

Quelle des Konzepts: On-call- Google SRE Workbook. Das Format und Muster dieser Notiz ist ein unabhängiges Vorschlagsdesign für die Betriebsdokumentation.

Eine nützliche Dokumentation sollte die nächste Entscheidung zu einem Zeitpunkt klären, wenn der Fokus zu niedrig ist. Für mich ist es besser, eine detaillierte Seite zu starten als einen großen Ordner mit alten Befehlen. Natürlich ist eine Seite der einzige Einstiegspunkt; spezielle Details können in Linkdokumente aufgenommen werden.

Was sollte auf der ersten Seite stehen?

• Anwendung und Bedeutung: Was macht dieser Service für den Benutzer und was macht er?
• Eigentümer und Referral Path: Wo ist die technische, Nachfolge- und organisatorische Kontaktmethode?
• Anlagen: Wie lautet der logische Name der erforderlichen Dienste, des Standorts und der Überprüfungsreihenfolge?
• Gesundheit und Beweise: Was sind die erfolgreichen Benutzertests, der Standort und die bekannten Fehlerzeichen?
• Erholung und Rückkehr: Was ist der bestätigte Prozedurlink, der Backup-Referenzort und die Bedingungen für die Einstellung von Operationen?
• Documentary Credit: Wer und welches Datum hat es an die reale Situation angepasst?

Eine hypothetische Stichprobe.

Für die „interne Berichterstattung kann geschrieben werden: Pflicht ist eine tägliche Berichterstattungsshow; wesentliche Zugehörigkeit, Datenbankbericht; Gesundheitstest ist die Eingabe des Testkontos und das Öffnen des Beispielberichts; im Fehlerfall wird die Ereigniszeit und die Anwendungs-ID überprüft und dann das Anwendungsprotokoll. Wahre Namen und Routen müssen von derselben Umgebung ausgefüllt werden.

Der Wert dieser Stichprobe liegt nicht in der Anzahl der Felder; die nächste Person versteht, wo sie anfangen soll und welche Ergebnisse gültig sind. Bestellungen wie "Wenn es gebrochen ist, Start-up" sind kein zuverlässiger Leitfaden ohne Bedingung, Nebeneffekt und Erfolgsmaßstab.

Die Dokumentation braucht den Test.

Bitten Sie den Autor, einem Testszenario mit demselben Leitfaden nicht zu folgen. Wo immer er eine mündliche Anfrage stellen musste, wurde wahrscheinlich eine echte Zweideutigkeit gefunden. Überprüfen Sie das Dokument nach dem wichtigen Servicewechsel.

Mein Vorschlag: Lassen Sie das Passwort, den Token und den privaten Schlüssel nicht auf der Seite; Erwähnen Sie nur die Methode für den Zugriff auf den sicheren Tank. Das Dokument muss gefunden und auf das Niveau des Publikumszugangs zugeschnitten werden. Halten Sie die öffentliche Version oder das Bildungsmuster von echten Netzwerkinformationen getrennt.

Verwandte Studie: Überprüfen Sie die Liste vor dem Start..