So erstellen Sie benutzerfreundliche Dokumentationen mit Simplified Technical English

How To Create User-Friendly Documentations With Simplified Technical English

Die englische Sprache ist eine der am weitesten verbreiteten Sprachen im technischen Schreiben. Die englische Sprache ist jedoch kompliziert - reich an Idiomen, Verbalphrasen, Redewendungen, Synonymen, mehrdeutigen Wörtern und Begriffen, die bei Nichtmuttersprachlern und sogar Muttersprachlern für Verwirrung sorgen können. Dies ist einer der Hauptgründe, warum einige Benutzer Handbücher nicht lesen.
Beim Erstellen einer Dokumentation ringt wohl jeder technische Redakteur mit der schwierigen Aufgabe, komplexe technische Begriffe in sehr einfachen und leicht verständlichen Worten, Sätzen und Anweisungen zu vermitteln. In den meisten Fällen wird die Leistung des technischen Redakteurs anhand des Benutzer-Feedbacks gemessen.
Um technische Dokumentationen wie beispielsweise Benutzerhandbücher, Hilfedateien, Sicherheitsleitfäden etc. verständlicher und benutzerfreundlich zu machen, hat die Aerospace and Defence Industries Association of Europe (ASD) das Simplified Technical English (STE) entwickelt, das auch als ASD-STE100 oder als die Thumbs-up-Technik bekannt ist.

Das STE ist in erster Linie für das Schreiben von übersichtlichen und eindeutigen Inhalten wichtig, insbesondere für Gebrauchsanweisungen wie z. B. Wartungsanleitungen, Benutzerhandbücher, Sicherheitsleitfäden und andere Hilfedokumentationen. Sie können lernen, durch die Anwendung des Simplified Technical English ein hervorragendes Handbuch zu schreiben.

So wenden Sie das Simplified Technical English (STE) an

Die Thumbs-up-Technik beinhaltet drei wichtige Schritte der Anwendung des Simplified Technical English. Diese Schritte sind:

  1. Bestimmen Sie die relevanten Informationen und löschen Sie die irrelevanten Informationen.
  2. Prüfen Sie die zugelassene Bedeutung von Wörtern im online erhältlichen STE-Wörterbuch
  3. Ändern Sie Ihre Sätze, indem Sie eine einfache und leicht verständliche Sprache entsprechend den Vorschlägen des STE-Wörterbuchs verwenden.

1. Bestimmen Sie die relevanten Informationen und löschen Sie die irrelevanten Informationen.

Viele Anleitungen wie etwa Warnungen und Aufgabenbeschreibungen enthalten häufig irrelevante Informationen darüber, wie die Benutzer eine Aufgabe durchführen können.

Zum Beispiel: So installieren Sie die Software-Version 2.11 schnell, innerhalb von wenigen Minuten und ohne Zeit zu verschwenden.
Kann wie folgt geändert werden: So installieren Sie die Software-Version 2.11 schnell.
Durch das Entfernen des anderen Satzteils "innerhalb von wenigen Minuten und ohne Zeit zu verschwenden" wird die Anweisung in keiner Weise geändert.

Im ersten Schritt der Thumbs-up-Technik geht es darum, alle irrelevanten Informationen zu löschen und nur die relevanten Informationen stehen zu lassen. Irrelevante Informationen können Sie ganz einfach identifizieren, indem Sie sich diese einfache aber logische Frage stellen: "Braucht der Benutzer diese Informationen oder dieses Wort wirklich, um diese Aufgabe durchzuführen?". Wenn das Entfernen eines Worts oder einer Phrase keinen Einfluss darauf hat, wie die Aufgabe durchgeführt oder abgeschlossen wird, dann können Sie dieses Wort oder diese Phrase weglassen.

2. Prüfen Sie die zugelassene Bedeutung von Wörtern im online erhältlichen STE-Wörterbuch.

Das Online-STE-Wörterbuch enthält die zugelassene Bedeutung von Wörtern, die technische Dokumentationen für Benutzer leichter verständlich macht. Wahrscheinlich werden Sie beim Schreiben Ihrer Dokumentationen Wörter verwenden, bei denen Sie sich nicht so sicher sind, ob die Benutzer die beabsichtigte Bedeutung verstehen werden.

Sie können das online erhältliche STE-Wörterbuch als Leitfaden verwenden, um zu überprüfen und sicherzustellen, dass Ihre Dokumentationen benutzerfreundlich sind. Die Verwendung von zugelassenen und nicht zugelassenen Wörter kann in den folgenden vier Schreibregeln folgendermaßen zusammengefasst werden:

  1. Verwenden Sie nur die in dem STE-Wörterbuch aufgeführten Formen von Verben und Adjektiven.
  2. Halten Sie sich an die in dem STE-Wörterbuch zugelassene Bedeutung eines Wortes. Verwenden Sie das Wort nicht anstelle eines anderen Worts oder mit einer anderen Bedeutung.
  3. Verwenden Sie nur die in dem Wörterbuch aufgeführten Wörter.
  4. Verwenden Sie die zugelassenen Wörter nur im Rahmen der gegebenen Sprache.

Ziehen Sie für das Schreiben Ihrer Dokumentation ein HET wie beispielsweise HelpNDoc in Erwägung, das mehrere Wörterbücher umfasst, um sicherzustellen, dass der Inhalt so perfekt wie möglich ist.

3. Ändern Sie Ihre Sätze, indem Sie eine einfache und leicht verständliche Sprache entsprechend den Vorschlägen des STE-Wörterbuchs verwenden.

Dieser Schritt bezieht sich auf die praktische Anwendung des ersten Schritts des Simplified Technical English. Zunächst müssen Sie die relevanten Informationen in Ihrer Dokumentation bestimmen und beibehalten. Löschen Sie alle irrelevanten Informationen. Es gibt zwei Dinge, die Sie tun können, um die Sätze in Ihren Dokumentationen in das STE zu konvertieren.

Schlagen Sie Ihre Sätze zuerst unter dem "Approved Example" ("Zugelassenes Beispiel") im STE-Wörterbuch nach. Es gibt darin 66 Schreibregeln; auch wenn Sie nicht alle kennen, können Sie die üblichen ähnlichen Sätze aus dieser Spalte kopieren und einfügen oder ihre Struktur nachahmen, um Ihre eigenen Sätze zu erstellen.

Legen Sie dann die wichtigsten Informationen dar und vermitteln Sie diese mit einer einfachen, leicht verständlichen Sprache. Das Erstellen von Dokumentation in einer kontrollierten Sprache erfordert einen funktionellen Ansatz. Praktischerweise gibt es spezifische Regeln für Textfunktionen wie Anweisungen, Ergebnisse oder Warnhinweise. Hier sind 2 wichtige Beispiele für funktionelle Regeln einer kontrollierten Sprache:

1. Beispiel:
Textfunktion: Anweisung
Muster: Verb (Infinitiv) + Artikel + Objekt + Satzzeichen.
Beispieltext: Click the button. (Klicken Sie auf den Button.)

2. Beispiel:
Textfunktion: Ergebnis
Muster: Artikel + Objekt + Verb (Präsens) + Satzzeichen.
Beispieltext: The Expense Report window appears. (Das Kostenabrechnungs-Bildschirmfenster wird angezeigt.)

Die beiden Beispiele vermitteln den wichtigsten Informationsinhalt und verwenden dabei eine sehr einfache und leicht verständliche Sprache. Beachten Sie diese Regeln, wenn Sie Ihre Sätze ändern, um sie in das STE zu konvertieren.

Wir wünschen Ihnen viel Freude am Dokumentieren!