Was macht Nachtschicht-Schritte?
Was dies ist
Die meisten Prozeduren werden von Personen geschrieben, die die Aufgabe bereits kennen. Am Schreibtisch lesen sie sich gut. Sie versagen um 3 Uhr morgens, in einem lauten Raum, auf einem Handy, in einer Zweitsprache oder wenn der Leser Angst hat, etwas kaputt zu machen. Das Versagen ist vorhersehbar: zwei Aktionen in einem Schritt, eine Warnung, die nach dem Schritt steht, den sie sichern soll, eine Bedingung, die am Ende des Satzes kommt, ein Passivsatz, der verbirgt, wer handeln muss, und Wörter wie „richtig“, die den Leser raten lassen.
Diese Fähigkeit verwandelt solchen Text in Schritte, die eine Person buchstäblich befolgen kann. Sie overnimmt die Disziplin kontrollierter Sprachen aus der Luftfahrt- und Industrieinstandhaltung (kurze Sätze, eine Aktion pro Satz, Aktiv, ein Wort für eine Sache), die Reihenfolge von Sicherheitshinweisen auf Geräteetiketten (Signalwort, Gefahr, Folge, Vermeidung) und die Gewohnheit, nach jedem riskanten Schritt ein erwartetes Ergebnis zu nennen, damit der Leser weiß, wann er aufhören muss.
Es ist kein „menschlich klingen lassen“-Durchgang. Das Ziel ist eine Prozedur, die nicht falsch gelesen werden kann, selbst wenn sie ein wenig schlicht klingt.
Wann man sie verwendet
- Runbooks, Vorfallspielbücher, Bereitschafts-Checklisten, Bereitstellungs- und Rollback-Schritte.
- Einrichtungs- oder Reparaturanleitungen für Hardware, Heimgeräte, Laborausstattung oder Büro-IT.
- Standardarbeitsanweisungen (SOPs) und Übergabenotizen für eine andere Person oder eine andere Schicht.
- Anleitungen, die maschinell übersetzt oder von Nicht-Muttersprachlern gelesen werden.
- Jeder Text, bei dem ein falsch gelesener Schritt Daten, Geld oder Verletzungen verursachen kann.
Nicht verwenden für Essays, Werbetexte oder konzeptionelle Erklärungen. Diese brauchen eine andere Stimme.
Die Regeln (Standardstufe)
| # | Regel | Grenze oder Test |
|---|---|---|
| R1 | Eine Aktion pro Schritt | Kein „, dann“, „und dann“, „;" oder zwei Verben verbunden mit „und" in einem Schritt |
| R2 | Kurze Anweisungssätze | 20 Wörter auf Englisch, etwa 35 Zeichen auf Chinesisch |
| R3 | Kurze beschreibende Sätze | 25 Wörter auf Englisch, etwa 45 Zeichen auf Chinesisch |
| R4 | Imperativ, Aktiv | Beginne mit dem Verb. Nenne den Handelnden, wenn es nicht der Leser ist |
| R5 | Bedingung zuerst | „Wenn das Licht rot ist, anhalten." niemals „Anhalten, wenn das Licht rot ist." |
| R6 | Ein Wort, eine Bedeutung | Lege Begriffe in einem Glossar fest. Tausche niemals Synonyme zur Abwechslung |
| R7 | Exakte Werte | Zahlen mit Einheiten, Bezeichnungen genau wie auf dem Bildschirm oder Gerät gezeigt |
| R8 | Sicherheitshinweis vor dem Schritt | Signalwort, Gefahr, Folge, was zu tun ist |
| R9 | Erwartetes Ergebnis nach riskanten Schritten | „Ergebnis: …" und was zu tun ist, wenn das Ergebnis abweicht |
| R10 | Keine Ratewörter | Entferne „richtig", „bei Bedarf", „sicherstellen", „sollte", „einfach" |
Strenge Stufe (für sicherheitskritische oder regulierte Texte): jede Regel ohne Ausnahme anwenden, keine Absicherungen erlauben und nach jedem Schritt eine Ergebniszeile einfügen. Leichte Stufe (für bereits gute interne Notizen): nur R1, R5, R8 und R9 anwenden.
Signalwörter
Verwende das niedrigste Wort, das noch zutrifft. Übertreibe nicht.
- GEFAHR: führt bei Nichtbeachtung zu Tod oder schweren Verletzungen.
- WARNUNG: kann bei Nichtbeachtung zu Tod, schweren Verletzungen oder Verlust wichtiger Daten oder Geld führen.
- VORSICHT: kann zu leichten Verletzungen oder behebbaren Schäden führen.
- HINWEIS: kein Verletzungsrisiko; nur Sach-, Daten- oder Zeitrisiko.
Jeder Sicherheitshinweis hat drei Teile: was die Gefahr ist, was passiert, wenn der Leser sie ignoriert, und was zu tun ist. „Vorsicht" ist kein Sicherheitshinweis.
Wie man arbeitet
- Fülle die Aufgabenkarte aus. Bevor du bearbeitest, notiere: den Zielzustand („Festplatte 2 wird wiederhergestellt"), wer die Anleitung befolgt (Rolle, Sprache, Bedingungen wie Handschuhe, Lärm, Handybildschirm, Nacht), was sie haben (Zugriff, Werkzeuge, Zeit), die Gefahren und die Abbruchbedingungen. Frage den Benutzer nach allem, was du nicht ableiten kannst. Eine fehlende Abbruchbedingung ist die häufigste Lücke.
- Liste die Fakten auf, die du behalten musst. Jede Zahl, Einheit, Bezeichnung, jeder Befehl, jede Reihenfolgenbedingung, Warnung und Bedingung. Die Umschreibung muss alle enthalten und nichts hinzufügen. Wenn du glaubst, ein Wert ist falsch, markiere ihn; korrigiere ihn nicht stillschweigend.
- Teile in Aktionen auf. Ein Verb, das der Leser ausführt = ein Schritt. Navigation zählt („Zu Speicher gehen" und „Festplatte 2 auswählen" sind zwei Schritte). Verschiebe Hintergrundinformationen in einen kurzen Abschnitt „Bevor Sie beginnen".
- Schreibe jeden Schritt um. Verb zuerst, Bedingung zuerst, exakte Bezeichnungen in fett oder
code, Einheiten immer. Ersetze jedes Passiv, das einen Handelnden verbirgt: „Der Schlüssel wird generiert" wird zu „Das Werkzeug generiert den Schlüssel" oder besser zum Schritt, den der Leser ausführt, um ihn zu generieren. - Platziere die Sicherheitshinweise. Für jeden Schritt, der löscht, überschreibt, ausschaltet, neustartet, trennt, erhitzt, schneidet oder unter Druck setzt, setze den Hinweis direkt über den Schritt. Wähle das Signalwort aus der obigen Leiter.
- Füge Ergebnisse und Ausgänge hinzu. Schreibe nach jedem riskanten oder zustandsändernden Schritt, was der Leser sieht, wenn es funktioniert hat. Wenn das Ergebnis unterschiedlich sein kann, gib eine Zeile an: „Wenn Sie X sehen, anhalten und zu Wiederherstellung A gehen." Schreibe die Wiederherstellungsabschnitte.
- Lege das Glossar fest. Wähle einen Begriff pro Sache (z.B. „Einschub", nicht „Caddy" oder „Schlitten"). Speichere es als
glossary.json, wenn die Prozedur gepflegt wird. - Lint. Führe
python scripts/stepcheck.py lint procedure.md --glossary glossary.jsonaus. Korrigiere jeden UNSAFE- und REWORK-Befund oder erkläre, warum es ein Fehlalarm ist. - Führe einen wörtlichen Probedurchlauf durch. Lies nur die nummerierten Schritte, als jemand, der genau das tut, was jeder Satz sagt, und nichts weiter. Wo würden sie anhalten, raten oder etwas Schädliches tun? Korrigiere diese Stellen.
- Gib die umgeschriebene Prozedur zurück, dann eine kurze Änderungsliste (Regelnummern), die Liste der Fakten, die du nicht überprüfen konntest, und offene Fragen.
Das Hilfsskript
scripts/stepcheck.py ist ein Python-Linter für Markdown-Prozeduren (nur Standardbibliothek, Englisch oder Chinesisch).
| Code | Schweregrad | Bedeutung |
|---|---|---|
| HAZARD-NO-WARNING | hart | Ein riskanter Schritt hat keinen Sicherheitshinweis darüber |
| LATE-WARNING | hart | Der Sicherheitshinweis steht nach dem Schritt, den er sichern soll |
| WEAK-WARNING | korrigieren | Der Hinweis sagt nicht, was passiert |
| LONG | korrigieren | Anweisungssatz über der Grenze |
| STACKED | korrigieren | Mehr als eine Aktion in einem Schritt |
| HIDDEN-ACTOR | korrigieren | Passiv oder 被 verbirgt, wer handelt |
| HEDGE / VAGUE | korrigieren | Ratewörter |
| CONDITION-LAST | korrigieren | Die Bedingung kommt nach der Aktion |
| DRIFT | korrigieren | Ein verbotenes Synonym aus dem Glossar |
| NO-RESULT, LONG-DESC | Hinweis | Nur Empfehlung |
Ergebnis: BEREIT (exit 0), ÜBERARBEITUNG (exit 1), UNSICHER (exit 2). Das Skript verwendet Wortlisten und Muster, daher übersieht es manchmal etwas und markiert gelegentlich einen korrekten Satz. Es ersetzt nie Schritt 9.
Beispiel
Vorher:
- Schalten Sie das NAS aus, falls es noch läuft.
- Ziehen Sie den Einschub für Festplatte 2 heraus und legen Sie die neue Festplatte ein. VORSICHT: Die alte Festplatte kann heiß sein.
Nachher:
WARNUNG: Schalten Sie das NAS aus, bevor Sie eine Festplatte entfernen. Eine Festplatte, die während des Betriebs entfernt wird, kann die zweite Festplatte beschädigen. 5. Drücken Sie den Netzschalter 2 Sekunden lang, um das NAS auszuschalten. Ergebnis: Alle Lampen an der Vorderseite erlöschen nach etwa einer Minute. VORSICHT: Die alte Festplatte kann nach Gebrauch heiß sein. Halten Sie sie am Einschub fest, sonst können Sie sich die Finger verbrennen. 6. Ziehen Sie den Einschub für Festplatte 2 heraus. 7. Legen Sie die neue Festplatte in den Einschub.
Änderungen: R1 (Schritt 4 aufgeteilt), R5 (Bedingung entfernt, indem Ausschalten ein eigener Schritt wurde), R8 (Warnung nach oben verschoben und eine Folge hinzugefügt), R9 (Ergebnis hinzugefügt). Vollständige Dateien sind in examples/.
Tipps
- Wenn der Quelltext falsch ist, ist die klarste Umschreibung immer noch falsch. Markiere zweifelhafte Werte in der Änderungsliste.
- Behalte Befehle, Pfade und Bildschirmbezeichnungen bytegenau bei. Klarer Text um einen falsch getippten Befehl herum ist schlimmer als das Original.
- Ein Schritt, der eine lange Erklärung braucht, sind normalerweise zwei Schritte plus eine Notiz davor.
- Nummeriere Schritte fortlaufend. Beginne die Nummerierung innerhalb einer Prozedur nicht neu; verwende separate Abschnitte für die Wiederherstellung.
- Lies die chinesische und die englische Version nebeneinander, wenn du beide erstellst: jeder Schritt sollte eins zu eins abbilden.
- Gib niemals an, dass die Ausgabe mit einem offiziellen Standard für kontrollierte Sprachen konform ist. Sage „in einem kontrollierten Stil geschrieben".