Informationen zum Schreiben übersetzungsfreundlicher Inhalten
Verwende die folgenden Richtlinien, um sicherzustellen, dass die von dir erstellten Inhalte erfolgreich übersetzt werden können. Weitere Informationen findest du unter Styleguide.
- Verwende generische Beispiele, die von den meisten Menschen verstanden werden können.
- Vermeide kontroverse oder für eine Gruppe kulturspezifische Beispiele.
- Schreibe im Aktiv.
- Schreibe einfache, kurze und leicht verständliche Sätze.
- Vermeide die Verwendung von zu vielen Pronomen, durch die Texte undeutlich werden können.
- Vermeide die Verwendung von Jargon und Witzen.
- Vermeide negative Sätze.
- Verwende nach Möglichkeit branchenübliche Abkürzungen, und erläutere eigene Abkürzungen.
- Verwende den Indikativ.
- Vermeide redundante und langatmige Wendungen.
- Vermeide die übermäßige Verwendung aneinandergereihter Wörter (zusammengesetzte Substantive). Für Übersetzer*innen könnte nicht immer klar erkennbar sein, welches Wort sich worauf bezieht.
- Vermeide unsichtbare Plurale, bei denen nicht klar ist, ob das erste Substantiv im Singular oder Plural stehen soll.
- Vermeide Nominalisierungen.
- Vermeide die Verwendung mehrdeutiger Modalverben.
- Vermeide geschlechtsspezifische Wörter.
- Vermeide Präpositionalphrasen.
- Vermeide unklare Nomen und Pronomen (unklare Subjekte).
- Beschränke die Verwendung von Inlinelinks auf ein Minimum. Falls Inlinelinks erforderlich sind, stelle ihnen einen Satz wie „Weitere Informationen findest du unter ‚Linkname‘“ voran. Alternativ kannst du relevante Links zu einem Abschnitt „Weitere Informationen“ am Ende des Artikels hinzufügen.
Beispiele
Dieser Abschnitt enthält Beispiele zum Befolgen unserer Richtlinien für das Schreiben einer übersetzungsfreundlichen Dokumentation.
Vermeiden länderspezifischer Informationen
Vermeide beispielsweise 0800er-Nummern und länderspezifische Adressen. Falls erforderlich, gib an, für welche Länder die Informationen gelten.
Vermeiden der Verwendung aneinandergereihter Wörter (zusammengesetzte Substantive)
Viele aneinandergereihte Wörter können zu falschen Übersetzungen führen, da nicht einfach erkennbar ist, was sich worauf bezieht. Verwende beispielsweise „Standardquelleinstellungen für das öffentliches Repository“ statt „öffentliche Repositorystandardquelleneinstellungen“.
Vermeiden von unsichtbaren Pluralen
Bei der Verwendung des Begriffs „Dateiabruf“ ist es unklar, ob es sich dabei um eine oder mehrere Dateien handelt. Sorge für mehr Kontext, um Mehrdeutigkeiten zu vermeiden. Im genannten Beispiel kannst du „Abrufen aller Dateien“ oder „Abrufen der source.md-Datei“ verwenden.
Vermeiden von Nominalisierungen
Verwende beispielsweise „abschließen“ statt „zum Abschluss kommen“.
Vermeide die Verwendung mehrdeutiger Modalverben.
Vermeide die Verwendung von Wörtern wie „dürfte“ oder „könnte“. Verwende klare Formulierungen, um Mehrdeutigkeiten zu vermeiden.
Vermeiden von Präpositionalphrasen
Schreibe direkter, anstatt „nach mehreren Versuchen“ oder „gemäß dem Repositoryprotokoll“ zu schreiben. Schreibe beispielsweise „nach drei Versuchen“.
Vermeiden unklarer Nomen und Pronomen
Bei der Verwendung unklarer Nomen und Pronomen ist es nicht immer klar, auf wen oder was du dich beziehst, insbesondere wenn diese Inhalte übersetzt werden müssen. Zum Beispiel: „Maintianer*innen und Mitwirkende haben Zugriff auf Dateien und Kommentare. Im Pull Request nehmen sie Änderungen daran vor.“ In diesem Satz ist nicht klar, ob die Änderungen an der Datei oder den Kommentaren vorgenommen werden. Wenn ein Pronomen über mehr als ein Bezugswort verfügt, kannst du entweder den Satz umformulieren, um das Bezugswort klar zu machen, oder das Pronomen durch ein Nomen ersetzen, um Mehrdeutigkeit zu vermeiden.
Beschränke die Verwendung von Inlinelinks auf ein Minimum.
Befolge beim Einfügen von Links nach Möglichkeit unseren Styleguide. Verwende beispielsweise nicht den folgenden Satz:
Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.
Verwende stattdessen diesen Satz:
OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)."