Anleitungen zur Fehlerbehebung schneller per Spracheingabe schreiben

Wenn Sie dasselbe Problem mehrfach lösen, lohnt sich eine Anleitung zur Fehlerbehebung. Dabei reicht es nicht, nur die Lösung festzuhalten. Leser müssen auch erkennen, ob die Anleitung zu ihrer Situation passt, was sie prüfen sollen und wann sie aufhören oder Hilfe anfordern sollten.

Mit Spracheingabe können Sie die Erklärung festhalten, solange die Details noch präsent sind. Lassen Sie Ihre Notizen auf dem Mac geöffnet und erklären Sie den Ablauf so, als würden Sie einem Kollegen helfen. Anschließend überarbeiten Sie den Text zu einer Anleitung, die ohne Ihre Begleitung funktioniert. Das Diktat liefert den Entwurf; die Schritte müssen Sie gesondert überprüfen.

1. Mit dem Symptom beginnen, nicht mit einer Vermutung

Wählen Sie ein beobachtbares Problem als Titel. „Freigegebenen Projektordner nicht öffnen können“ ist konkreter als „Kontoprobleme“. Beschreiben Sie zu Beginn, was auf dem Bildschirm zu sehen ist und für welche Situation die Anleitung gilt.

Sammeln Sie vor dem Diktieren drei Angaben:

• Symptom: Die genaue Meldung oder das sichtbare Verhalten.
• Geltungsbereich: Die geprüfte Anwendung, Kontoart oder Umgebung.
• Erfolgskriterium: Woran der Leser erkennt, dass das Problem gelöst ist.

Trennen Sie Beobachtungen von möglichen Ursachen. Ein falsch ausgewähltes Konto kann eine Erklärung sein, ist aber nicht automatisch die Ursache jedes Zugriffsfehlers.

2. Prüfung, Ergebnis und nächsten Schritt diktieren

Erklären Sie für jeden Schritt, was zu prüfen ist, welches Ergebnis zu erwarten ist und wie es danach weitergeht. „Konto prüfen“ lässt Fragen offen. „Vergleichen Sie die angemeldete E-Mail-Adresse mit der Adresse auf der Einladung“ beschreibt eine konkrete Handlung.

Diktieren Sie zunächst den häufigsten Ablauf. Ergänzen Sie eine Verzweigung nur dann, wenn ein anderes Ergebnis eine andere Handlung erfordert. Beschränken Sie nummerierte Schritte möglichst auf jeweils eine Aktion. Ersetzen Sie „Prüfen Sie, ob es funktioniert“ durch ein sichtbares Ergebnis.

Fügen Sie genaue Schaltflächenbezeichnungen, Fehlermeldungen und Pfade anschließend aus der Quelle ein. Spracheingabe hilft bei der Erklärung; Details, bei denen ein einzelnes Zeichen entscheidend ist, sollten Sie abgleichen.

3. Aus einer Erklärung eine kurze Anleitung machen

Das folgende Beispiel ist fiktiv. Passen Sie Aktionen und Bezeichnungen an das tatsächlich geprüfte System an.

Gesprochener Entwurf: „Vielleicht ist das andere Konto geöffnet. Erst die Einladung vergleichen, gegebenenfalls das eingeladene Konto nehmen und sonst den Besitzer des Ordners fragen.“

Überarbeitete Anleitung:

Problem: Sie öffnen die Einladung zu einem Projektordner und erhalten eine Meldung, dass der Zugriff verweigert wurde.

Gilt für: Personen, die bereits eine Einladung zu diesem Ordner haben.

1. Vergleichen Sie das aktuell angemeldete Konto mit der E-Mail-Adresse auf der Einladung.
2. Unterscheiden sich die Adressen, melden Sie sich mit dem eingeladenen Konto an und öffnen Sie den ursprünglichen Ordnerlink erneut. Stimmen sie überein, fahren Sie mit Schritt 3 fort.
3. Bleibt der Zugriff gesperrt, bitten Sie den Ordnerbesitzer, Einladung und Berechtigungen zu prüfen. Nennen Sie die Fehlermeldung und die geprüfte Kontoadresse.

Erledigt, wenn: Das eingeladene Konto den Ordner öffnen und die erwarteten Dateien sehen kann. Ist das nach Schritt 2 der Fall, sind keine weiteren Schritte nötig.

Die Anleitung zeigt sowohl den nächsten Schritt als auch den Punkt, an dem die Bearbeitung endet. Sie verspricht nicht, dass ein Kontowechsel jedes Berechtigungsproblem löst.

4. Eine wiederverwendbare Vorlage nutzen

Titel: [Beobachtbares Problem]

Gilt für: [Geprüfte Umgebung und Voraussetzungen]

Prüfung: [Eine konkrete Handlung]

Erwartetes Ergebnis: [Sichtbarer Zustand]

Bei Abweichung: [Nächste Prüfung oder Ansprechperson]

Abschluss: [Eindeutiges Erfolgskriterium]

Zuletzt geprüft: [Datum und relevante Version oder Umgebung]

Wiederholen Sie Prüfung, Ergebnis und nächste Handlung nur dort, wo es nötig ist. Eine kurze Anleitung mit klarem Geltungsbereich lässt sich leichter pflegen als eine Sammlung unzusammenhängender Lösungsversuche.

5. Den Entwurf vor der Veröffentlichung durchgehen

Führen Sie die Schritte in der beschriebenen Umgebung der Reihe nach aus. Prüfen Sie sowohl den erfolgreichen Ablauf als auch die aufgeführten Verzweigungen. Entfernen Sie ungetestete Lösungen, ergänzen Sie fehlende Übergänge und kontrollieren Sie Namen sowie Verneinungen im diktierten Text. Lassen Sie jemanden ohne Vorwissen markieren, wo die Anleitung Kenntnisse voraussetzt, die nicht erklärt werden.

Weitere Anregungen bieten unsere Beiträge zum Schreiben von Dokumentation per Spracheingabe und zu klaren Fehlerberichten.

TypeFree ist eine einfache Möglichkeit, Gesprochenes in bearbeitbaren Text umzuwandeln und schneller zu schreiben. Diktieren Sie Ihre nächste Problemlösung, überprüfen Sie die Schritte und machen Sie daraus eine Anleitung, die Ihr Team wiederverwenden kann.