Gute Dokumentation — die Sicht eines Übersetzers

Introduktion

Übersetzer bieten wertvolle Einblicke in das Verfassen klarer und prägnanter Dokumentationen. Sie wissen besser als die meisten anderen, was sich nicht gut übersetzen lässt und was einen Leser verwirrt. In diesem Dokument werden einige dieser Probleme untersucht und bewährte Vorgehensweisen für die Dokumentations-Erstellung hervorgehoben.

Über den Autor

Mithilfe der Softwaredokumentation können Benutzer besser verstehen, wie sie eine bestimmte Software effektiv nutzen können. Sie müssen verstehen, was sie am Ende haben und welche Vorteile sie haben werden. Gleichzeitig bedeutet das Erstellen einer Dokumentation, dass Sie diese nicht nur für sich selbst, sondern auch für Ihr Netzwerk und für andere Personen erstellen, die sie möglicherweise lesen. Andere Personen stammen möglicherweise nicht aus englischsprachigen Ländern. Das bedeutet, dass Englisch für sie nicht ihre Muttersprache ist. Befolgen Sie daher diese Grundregeln, um Ihre Dokumentation für alle Benutzer lesbarer zu machen.

Verständliche Sprache verwenden

Es ist grundsätzlich nicht ersichtlich, wer die Nutzer der Dokumentation sind. Ob der Benutzer sich auf diesem Gebiet auskennt oder nicht, ob er ein erfahrener Entwickler oder ein Anfänger ist. Einfache Sprache bedeutet klare, prägnante Kommunikation, die für die Zielgruppe auf den ersten Blick leicht verständlich ist. Vermeiden Sie Fachjargon, übermäßig technische Begriffe und komplexe Satzstrukturen und verwenden Sie stattdessen eine einfachere, klar strukturierte Sprache. Ziel ist es, sicherzustellen, dass die Botschaft für ein breites Publikum zugänglich und verständlich ist, unabhängig von dessen Hintergrund oder Leseniveau. Dies kann häufig durch Vereinfachung der Syntax von Sätzen oder Befehlen auf eine einfachere Form erreicht werden.

Vermeiden Sie Redewendungen, Fachjargon, Akronyme und Abkürzungen

Redewendungen, Fachjargon, Abkürzungen und Akronyme können für Leser, die damit nicht vertraut sind, verwirrend sein. Dies gilt insbesondere für Nicht-Muttersprachler, neue Mitarbeiter oder Personen, die mit Ihrer spezifischen Branche nicht vertraut sind.

Redewendungen, Idioms sind oft kulturspezifisch und können für internationale Leser schwer verständlich sein.\ Jargon umfasst Fachbegriffe, die nur Experten auf einem bestimmten Gebiet verstehen.\ Kontraktionen ersetzen englische Wörter durch Abkürzungen, aber diese gibt es nicht immer in allen Sprachen, was die Übersetzung erschwert.\ Akronyme können mehrdeutig sein, insbesondere wenn sie bei ihrer Verwendung nicht definiert sind.

Ein Beispiel:

❌ "Once you’ve got the hang of the dashboard, the rest is a piece of cake." In diesem Fall verwendet der Autor sowohl eine Kontraktion, Slang als auch eine Redewendung.

✅ "Once you have learned how to use the dashboard, the rest is easy." Durch Ersetzen der Kontraktion, des Slangs und der Redewendung durch die jeweils zugehörigen Wörter wird die Bedeutung klar.

Bildliche Ausdrücke, wie etwa Redewendungen, sind oft schwer zu übersetzen. Technische Redakteure oder Übersetzer haben möglicherweise Schwierigkeiten, dieselbe Bedeutung in anderen Sprachen wiederzugeben.

Beispiel:

❌ "Let’s touch base next week to circle back on the open tickets."

✅ "Let us meet next week to review the unresolved support requests."

Fachjargon und Abkürzungen können – sogar innerhalb derselben Organisation – verwirrend sein, wenn ihre Bedeutung nicht allgemein bekannt ist.

Beispiel:

❌ "Upload the CSV to the CMS and tag it according to SOPs."

✅ "Upload the CSV (Comma-Separated Values file) to the content management system and label it according to the standard operating procedures."

Hinweis: Wenn Sie Akronyme verwenden möchten, definieren Sie diese immer gleich beim ersten Mal: „Customer Relationship Management (CRM)-System“.

Durch die Vermeidung von Redewendungen und unnötigem Fachjargon wird die Bedeutung Ihres Dokuments klarer. Das Ersetzen von Kontraktionen durch die entsprechende Wörter, die sie darstellen, erleichtert die Übersetzung in alle Sprachen. Ihr Dokument ist für den Leser am verständlichsten, wenn Sie Akronyme ersetzen oder definieren.

Tätigkeitsform (Aktiv) verwenden

Die aktive Form betont, wer die Handlung ausführt, und macht deutlich, wer oder was für die Handlung des Verbs verantwortlich ist.

Beispiel:

The system opens the dialog where you need to complete the form.

Bitte verzichten Sie auf die Verwendung der komplexen Form, da diese für die Leser verwirrend sein kann.

Weitere Informationen zur Verwendung der Aktivform und ihrer Bedeutung finden Sie in dieser Meinung und dieser externen Quelle.

Spezifische Schritte

Wenn die Dokumentation bestimmte Schritte enthält, trennen Sie diese voneinander.

Zum Beispiel:

Step 1 - Go to the section\ Step 2 - Click the button\ Step 3 - Complete the form\ ...\ Step N - save changes

Screenshots wenn nötig

Verwenden Sie bei Bedarf geeignete Screenshots. Das bedeutet, dass Sie nicht überall Screenshots hinzufügen müssen, sondern nur an den Stellen, an denen zusätzliche Erklärungen erforderlich sind.

Verwenden Sie Beispiele

Wenn Sie ein Formular ausfüllen müssen, geben Sie Beispiele dafür, wie Benutzer es ausfüllen können. Erwähnen Sie Einschränkungen, falls vorhanden.

Zusammenfassung

Beim Verfassen einer guten Dokumentation geht es nicht nur darum, dass sie technisch korrekt ist, sondern auch darum, dass sie für den Leser sofort verständlich ist. Dies ist besonders wichtig, wenn ein technisches Dokument in andere Sprachen übersetzt werden muss. In diesem Dokument wollte der Autor bestimmte Techniken zum Schreiben guter und klarer Dokumentationen hervorheben.

Author: Ganna Zhyrnova

Contributors: Steven Spencer