Styleguides sind zentralisierte Sprachrichtlinien, die definieren, wie Inhalte für eine bestimmte Sprache oder Region verfasst werden sollten. Sie helfen sicherzustellen, dass Ton, Terminologie, Formatierung und Ausgabe in Projekten und Teams konsistent bleiben.
Styleguides werden als Markdown-Dateien (.md) hochgeladen und in einer gemeinsamen Bibliothek gespeichert, die über das Dashboard der Phrase Platform zugänglich ist, indem Assets im linken Navigationsmenü ausgewählt wird. Sie können in Projekten angehängt und wiederverwendet werden in:
Wenn eine Markdown-Datei hochgeladen oder eine vorherige Version wiederhergestellt wird, generiert Phrase automatisch eine KI-optimierte Version des Styleguides. Diese Version wird in KI-Workflows verwendet, um die Ergebnisse des KI-Übersetzungsagent und MT Optimize zu verbessern, ohne dass für jeden Job individuelle Anweisungen erforderlich sind. Der KI-freundliche Styleguide ermöglicht es den KI-Diensten von Phrase, Ton und Formalität an die Benutzerpräferenzen anzupassen, erforderliche Terminologie und Formulierungen anzuwenden und regionale Konventionen zu befolgen.
Während der KI-Übersetzungsagent sowohl Termbanken als auch Styleguides berücksichtigt, setzen Styleguides die Terminologie aus einer Termbank nicht direkt durch. Die Verwendung von Styleguides verursacht keine zusätzlichen Kosten für die KI-Einheit (AIU).
Jeder Styleguide gilt genau für eine Region (zum Beispiel en-US oder de-DE). Wenn mehrere Varianten oder Anwendungsfälle unterschiedliche Regeln erfordern, müssen separate Styleguides erstellt werden.
Organisationen können bis zu 500 Styleguides hinzufügen.
Berechtigungen
-
Nur die Plattformorganisation Administratoren kann Styleguides erstellen, bearbeiten, löschen oder als Standard festlegen.
-
Benutzer mit der Rolle Plattformmitglied (z. B. Linguisten) können die Styleguides im Tab Assets einsehen. Sie können keine Änderungen vornehmen.
-
Projektmanager können Styleguides an Projekte anhängen.
-
Linguisten und Übersetzer können angehängte Styleguides in TMS und Strings-Editoren einsehen.
-
Benutzer können die neueste Version eines Styleguides als Markdown-Datei im Assets Tab herunterladen.
Datei- und Strukturanforderungen
-
Ein Styleguide im Markdown (.md) Format pro Sprache:
-
Maximale Größe: 150 KB
-
Bilder werden nicht unterstützt
-
-
Empfohlene Struktur:
-
Zweck und Umfang
-
Stimme und Ton
-
Grammatik- und Schreibregeln
-
Terminologie (genehmigte und unzulässige Begriffe)
-
Sprachkonventionen
-
Formatierungsstandards
-
Inhaltsartenrichtlinien
-
Fehlerbehebung und Fehlerstil (falls zutreffend)
Klare Überschriften und strukturierte Regeln verbessern sowohl die Lesbarkeit für Menschen als auch die Interpretation durch KI.
-
Im Folgenden finden Sie ein Beispiel für einen vollständigen, nicht widersprüchlichen Styleguide, der nach Bedarf angepasst werden kann:
Sprache: en-US
Anwendungsfall: SaaS B2B Produkt – Hilfe-Center und UI
# Styleguide: EN-US – Hilfe-Center-Artikel ## 1. Zweck & Umfang Dieser Styleguide definiert die Schreibstandards für alle **Hilfe-Center-Dokumentationen** in **Englisch (Vereinigte Staaten)**. Er gilt für: - Anleitungen - Funktionsbeschreibungen - Fehlerbehebungsanleitungen - FAQ-Einträge **Zielgruppe:** professionelle SaaS-Nutzer in technischen und geschäftlichen Rollen **Ziel:** den Nutzern helfen, Aufgaben schnell, sicher und ohne Verwirrung abzuschließen. --- ## 2. Stimme & Ton Der Inhalt des Hilfe-Centers sollte klingen: - **Klar und professionell** - **Unterstützend und lösungsorientiert** - **Selbstbewusst, nicht werblich** Wir schreiben als Leitfaden, der den Nutzern zum Erfolg verhilft – nicht als Marketingtext. ### Tonprinzipien | Tun | Nicht tun | |---|------| | Ruhig und direkt sein | Übermäßig lässig oder gesprächig sein | | Auf die nächsten Schritte fokussieren | Nur auf das eingehen, was schiefgelaufen ist | | Neutrale Sprache verwenden | Sarkasmus oder Humor verwenden | **Beispiele** - ✅ „Wenn die Verbindung fehlschlägt, überprüfen Sie Ihr API-Token und versuchen Sie es erneut.“ - ❌ „Ihr Token ist falsch. Korrigieren Sie es.“ --- ## 3. Grammatik & Schreibstil ### 3.1 Sprechen Sie den Leser direkt an Verwenden Sie **Sie**, um Anweisungen klar zu machen. - ✅ „Sie können Benutzer von der Admin-Seite verwalten.“ - ❌ „Benutzer können von der Admin-Seite verwaltet werden.“ --- ### 3.2 Bevorzugen Sie die aktive Stimme Die aktive Stimme ist kürzer und leichter zu folgen. - ✅ „Wählen Sie **Änderungen speichern**.“ - ❌ „Änderungen speichern sollten ausgewählt werden.“ --- ### 3.3 Halten Sie Sätze prägnant - Streben Sie nach **25 Wörtern oder weniger** - Eine Hauptidee pro Satz - Lange Erklärungen in Schritte oder Aufzählungen unterteilen --- ### 3.4 Verwenden Sie einfache Sprache Vermeiden Sie unnötige Komplexität. - ✅ „Starten Sie ein neues Projekt.“ - ❌ „Initiieren Sie die Erstellung eines neuen Projekts.“ --- ## 4. Terminologie & Konsistenz ### 4.1 Genehmigte Begriffe verwenden Verwenden Sie Produkt- und Funktionsnamen genau so, wie sie definiert sind. - Halten Sie die Großschreibung konsistent - Erfinden Sie keine Synonyme für Schlüsselkonzepte **Beispiel** - ✅ „Arbeitsbereich“ - ❌ „Raum“, „Projektbereich“, „Umgebung“ --- ### 4.2 Ungewöhnliche Abkürzungen definieren Allgemeine Begriffe (API, URL) benötigen keine Definition. Interne oder ungewöhnliche Abkürzungen sollten bei der ersten Verwendung erklärt werden. - ✅ „Single Sign-On (SSO)“ - ❌ „SSO“ ohne Kontext --- ### 4.3 US-Englisch-Konventionen Verwenden Sie immer **en-US Schreibweise**. - ✅ „anpassen“, „verhalten“ - ❌ „anpassen“, „verhalten“ --- ## 5. Formatierungs- & Markdown-Standards ### 5.1 Überschriften Verwenden Sie klare, auf Aufgaben basierende Überschriften. - ✅ „Setzen Sie Ihr Passwort zurück“ - ❌ „Übersicht über den Passwortzurücksetzungsprozess“ Überschriftenhierarchie: - `#` Artikeltitel - `##` Hauptabschnitte - `###` Unterabschnitte nur bei Bedarf --- ### 5.2 Listen Verwenden Sie nummerierte Listen für Sequenzen: 1. Öffnen Sie **Einstellungen** 2. Wählen Sie **Abrechnung** 3. Wählen Sie **Plan ändern** Verwenden Sie Aufzählungszeichen für Optionen: - Administratoren können Benutzer verwalten - Redakteure können Inhalte aktualisieren --- ### 5.3 UI-Elemente Formatieren Sie UI-Bezeichnungen konsistent: - Schaltflächen: **fett** - Navigationspfade: verwenden Sie Pfeile Beispiel: Gehe zu **Einstellungen → Abrechnung → Plan ändern**. --- ### 5.4 Links Links müssen das Ziel beschreiben. - ✅ „Siehe die Abrechnungsanleitung“ - ❌ „Hier klicken“ --- ## 6. Standardartikelstruktur Jeder Artikel im Hilfe-Center sollte dieser Struktur folgen: ### 1. Zusammenfassung Beginne mit 1–2 Sätzen, die das Ergebnis erklären. > Dieser Artikel erklärt, wie man seinen Abonnementplan ändert. --- ### 2. Voraussetzungen (optional) Liste die Anforderungen im Voraus auf. - Admin-Berechtigungen - Aktives Abonnement --- ### 3. Schritt-für-Schritt-Anleitungen Die Schritte sollten sein: - Handlungsorientiert - Eine Aktion pro Schritt - Als Befehle geschrieben Beispiel: 1. Gehe zu **Einstellungen**. 2. Wählen Sie **Abrechnung**. 3. Wählen Sie **Plan ändern**. --- ### 4. Erwartetes Ergebnis Informieren Sie den Benutzer, was passieren sollte. > Ihr neuer Plan tritt sofort nach der Bestätigung in Kraft. --- ### 5. Nächste Schritte (optional) Geben Sie verwandte Aktionen oder Links an. - Rechnungen verwalten - Zahlungsmethode aktualisieren --- ## 7. Fehlerbehebung & Fehler ### 7.1 Beruhigen Sie - ✅ „Wir konnten keine Verbindung herstellen. Bitte versuchen Sie es erneut.“ - ❌ „Verbindung fehlgeschlagen. Kritischer Fehler.” --- ### 7.2 Konzentrieren Sie sich auf Lösungen Fügen Sie immer hinzu, was der Benutzer als Nächstes tun sollte. - Anmeldeinformationen überprüfen - Berechtigungen bestätigen - Kontaktieren Sie den Support, falls erforderlich --- ### 7.3 Beschuldigen Sie niemals den Benutzer Vermeiden Sie Formulierungen wie: - „Sie haben etwas falsch gemacht“ - „Ungültige Eingabe“ (ohne Erklärung) Bevorzugt: > „Das Token könnte abgelaufen sein. Erzeugen Sie ein neues und versuchen Sie es erneut.“ --- ## 8. Do / Don’t Zusammenfassung ### Do - Schreiben Sie aufgabenorientierte, schrittbasierte Inhalte - Verwenden Sie einheitliche Terminologie - Halten Sie die Sätze kurz und direkt - Verwenden Sie beschreibende Überschriften und Links - Bewahren Sie einen ruhigen, unterstützenden Ton ### Nicht tun - Fügen Sie Marketing-Sprache hinzu - Verwenden Sie Redewendungen oder Slang - Mischen Sie Begriffe für dasselbe Konzept - Beschuldigen Sie den Benutzer bei der Fehlersuche - Schreiben Sie lange Absätze ohne Struktur --- ## Beispiel (Bevorzugt) Um Ihren Plan zu ändern: 1. Gehen Sie zu **Einstellungen → Abrechnung** 2. Wählen Sie **Plan ändern** 3. Wählen Sie eine Option und klicken Sie auf **Bestätigen**
Stilrichtlinien werden in der gemeinsamen Bibliothek erstellt und verwaltet, die über das Dashboard der Phrase Platform zugänglich ist, indem Sie im linken Navigationsmenü auswählen. Die Seite listet alle in Ihrer Organisation verfügbaren Stilrichtlinien auf.
Wenn Sie bei Phrase TMS, Phrase Strings oder Phrase Studio angemeldet sind, wählen Sie aus der linken Navigation, um die gemeinsame Bibliothek zu öffnen.
Eine Stilrichtlinie erstellen
Um eine neue Stilrichtlinie als Administrator zu erstellen, befolgen Sie diese Schritte:
-
Wählen Sie auf der Seite Neue Stilrichtlinie aus.
Die Seite wird angezeigt.
-
Konfigurieren Sie , und (optional).
Der Name muss eindeutig sein.
-
Ziehen Sie die Datei per Drag & Drop oder wählen Sie Datei hochladen aus, um die Stilrichtlinie als Markdown (.md) Datei hochzuladen.
-
Klicken Sie auf Stilrichtlinie erstellen.
Phrase generiert automatisch die KI-freundliche Version aus der hochgeladenen Datei. Das kann einige Sekunden dauern.
Die neue Stilrichtlinie wird der Seite hinzugefügt.
-
Optional, wählen Sie Als Standard festlegen.
Beim Anhängen von Styleguides an neue Projekte schlägt Phrase den Standard-Styleguide vor, wenn kein spezifischer Guide festgelegt ist. Der Vorschlag kann überschrieben werden.
Tipp
Entfernen Sie alle sprachspezifischen Regeln aus dem Standard-Styleguide.
Bearbeiten oder Löschen von Styleguides
Styleguides können aktualisiert, versioniert, geteilt oder entfernt werden. Von der Seite verwenden Sie das Menü neben einem aufgeführten Styleguide, um:
-
Als Standard festlegen
Markieren Sie den Styleguide als den vorgeschlagenen Standard, wenn kein spezifischer Guide in neuen Projekten ausgewählt ist. Der Standardvorschlag kann auf Projektebene überschrieben werden.
-
Löschen
Das Löschen eines Styleguides ändert nicht rückwirkend abgeschlossene oder laufende Aufträge. Nur die neueste Version eines Styleguides kann an neue Projekte angehängt werden.
Tipp
Überprüfen Sie vor dem Löschen eines Styleguides:
-
Ob es noch an aktiven Projekten oder Vorlagen angehängt ist
-
Ob es für die Einhaltung oder historische Referenz aufbewahrt werden muss
-
-
Öffentlichen Link kopieren
Generieren Sie einen schreibgeschützten Link zum Teilen mit externen Stakeholdern, die kein Phrase-Konto haben.
Auf der Seite wählen Sie das Bleistift-Symbol neben einem Styleguide, um die Seite zu öffnen und dessen Metadaten, Markdown-Datei oder Standardstatus zu aktualisieren.
Eine optionale Beschreibung der Änderungen kann vor dem Speichern hinzugefügt werden, um sie in die Versionshistorie aufzunehmen. Eine neue Version wird nur erstellt, wenn die Markdown-Datei ersetzt wird. Diese Version gilt nur für neue Aufträge oder für Aufträge, die in Projekten, in denen der Styleguide verwendet wird, noch nicht begonnen haben.
Versionshistorie verwalten
Styleguides führen eine Versionshistorie, falls Änderungen an bestehenden Versionen vorgenommen werden.
Um die Versionshistorie anzuzeigen und Versionen eines Styleguides wiederherzustellen, befolgen Sie diese Schritte:
-
Gehen Sie auf die -Seite und klicken Sie auf einen Styleguide in der Liste, um dessen Detailseite zu öffnen.
-
Wählen Sie Versionshistorie aus den
oben auf der Detailseite aus.
Das -Panel wird angezeigt.
-
Wählen Sie eine ältere Version aus dem Abschnitt aus.
Die ältere Version wird angezeigt.
-
Falls erforderlich, wählen Sie Diese Version bearbeiten in der aus.
Die vorherige Version wird wiederhergestellt, um eine neue aktive Version basierend darauf zu erstellen.
Das Wiederherstellen oder Bearbeiten einer früheren Version überschreibt nicht die Historie.
Sobald ein Styleguide in der Bibliothek erstellt wurde, kann er an Projekte in Phrase TMS, Phrase Strings und Phrase Studio angehängt werden.
Allgemeines Verhalten über Produkte hinweg:
-
Styleguides werden pro Zielsprache konfiguriert und gelten für das gesamte Projekt. Sie werden während der Vorübersetzung verwendet, wenn der KI-Übersetzungsagent eingesetzt wird, oder als Schritt im Post-Editing, wenn MT Optimize verwendet wird.
-
Wenn eine neue Version des Styleguides erstellt wird, gilt sie nur für neue Aufträge. Laufende Jobs verwenden die zum Zeitpunkt der Erstellung aktive Version.
-
KI-Funktionen verwenden automatisch den angehängten Styleguide, wenn dies unterstützt wird. Styleguides beeinflussen keine gesperrten Segmente, da MT Optimize diese nicht ändert. Standardmäßig lässt der KI-Übersetzungsagent auch Segmente aus einem Translation Memory (TM) unbeeinflusst, obwohl dies in den Voreinstellungen zur Vorübersetzung konfiguriert werden kann.
Phrase TMS
Styleguides können an ein Projekt oder eine Projektvorlage angehängt werden.
-
Beim Erstellen oder Bearbeiten eines Projekts oder einer Projektvorlage navigieren Sie zum Abschnitt und wählen einen Styleguide pro Ziel-Sprache aus.
Das System kann automatisch den relevantesten Styleguide basierend auf der Übereinstimmung der Sprache vorab auswählen. Die Vorauswahl kann jederzeit überschrieben oder gelöscht werden.
Hinweis
Nicht unterstützt in der klassischen Projektvorlagenansicht.
-
Änderungen an Projektvorlagen betreffen nur neu erstellte Projekte und Jobs. Bestehende Projekte werden nicht rückwirkend aktualisiert.
-
Angehängte Styleguides sind für Linguisten im
Bereich des CAT Web Editors als schreibgeschütztes Element sichtbar.
-
Anbieter in gemeinsamen Projekten können den zugewiesenen Styleguide des Auftraggebers nicht ändern.
-
In Szenarien mit gemeinsamen Jobs können Anbieter den zugewiesenen Styleguide verwenden, jedoch keine Konfiguration auf Projektebene ändern.
-
Phrase Strings
-
Auf einer Projektseite navigieren Sie zum Tab und wählen einen Styleguide pro Ziel-Sprache aus.
-
Angehängte Styleguides sind für Übersetzer auf der Schlüssel-Ebene im Menü der Strings Editor-Seitenleiste sichtbar.
Phrase Studio
-
Wenn ein Projekt erstellt wird, wählen Sie einen Styleguide für jede Zielsprache aus, die dem Projekt hinzugefügt wird.
Das System kann automatisch den relevantesten Styleguide basierend auf der Übereinstimmung der Sprache vorab auswählen. Die Vorauswahl kann jederzeit überschrieben oder gelöscht werden.
-
Die KI-freundliche Version des Styleguides wird im Hintergrund als kontextuelle Eingabe für die Arbeitsabläufe des KI-Übersetzungsagenten angewendet.