Wie Wissensdatenbank-Artikel geschrieben werden

Mitwirkende Mitwirkende Zuletzt aktualisiert:
Dies ist eine maschinengenerierte Übersetzung des englischen Artikels. Er wurde nicht von einem Menschen überprüft und kann Fehler enthalten. Wenn Sie diesen Inhalt überarbeiten möchten, können Sie hier beginnen.

Als Beitragender zur Wissensdatenbank helfen Sie mit Ihren Worten einer halben Milliarde Nutzer. Das ist eine große Aufgabe. Nutzer aus der ganzen Welt besuchen die Wissensdatenbank und erwarten einfache Lösungen, aber wir möchten sie auch mit unserem Tonfall erfreuen. Wie stellen Sie das an? Hier sind einige Dinge, die wir bei unserer Recherche herausgefunden haben.

Wir freuen uns über Vorschläge! Wenn Sie weitere Vorschläge haben, posten Sie diese im Diskussionsforum dieses Artikels.

Tonfall

Schreiben Sie mit Blick auf die Marke. Bei Mozilla geht es um die Wahlfreiheit der Nutzer. Wir glauben an Freiheit und Flexibilität. Wir legen Wert auf Datenschutz und Sicherheit. Wir sind eine von der Gemeinschaft getragene, gemeinnützige Organisation mit Beitragenden aus der ganzen Welt, die gemeinsame Werte teilen.

Sie müssen diese Geschichte nicht in jedem Artikel breittreten. Es ist nur etwas, das Sie im Hinterkopf behalten sollten, wenn Sie Funktionen beschreiben.

Schreibstil

Schreiben Sie für ein allgemeines, nicht-technisches Publikum.

Wir möchten, dass unsere Artikel für jeden nutzbar sind, nicht nur für fortgeschrittene Anwender. Das bedeutet, dass wir für ein allgemeines Publikum schreiben und nicht für eines, das mit Computertechniken und -terminologie sehr vertraut ist. Gehen Sie davon aus, dass die Person, für die Sie schreiben, ohne eine Schritt-für-Schritt-Anleitung nicht weiß, wie man Einstellungen ändert oder eine Schaltfläche zur Symbolleiste hinzufügt. Außerdem sollten wir davon ausgehen, dass die Standardeinstellungen der Anwendung oder des Betriebssystems nicht geändert wurden.

Zusammenfassend sollten Sie diese Richtlinien befolgen:

  1. Fassen Sie sich kurz. Die Leute kommen in die Wissensdatenbank, weil sie schnelle Lösungen suchen. Die inneren Abläufe des Tools sind ihnen vielleicht egal – sie wollen nur wissen, was sie tun sollen, um das Problem zu beheben. Kürzen Sie ruhig ein paar Wörter. Sehen Sie, wie viel Sie mit weniger Wörtern vermitteln können. Das ist wie Poesie!
  2. Bleiben Sie verständlich. Vermeiden Sie Fachjargon. Seien Sie präzise. Verwenden Sie im Titel und im Artikel Wörter, die auch der Leser verwenden würde. Wenn Ihr 13-jähriger Neffe es nicht verstehen würde, schreiben Sie es so, dass er es versteht. Im nächsten Abschnitt finden Sie eine ausführlichere Anleitung.
  3. Seien Sie freundlich, humorvoll und einfühlsam. (Kurz gesagt: Seien Sie menschlich.) Okay, Nutzer erwarten vom Support keinen Spaß. Das ist es, was dies so wirkungsvoll macht. Erheitern Sie den Tag des Nutzers mit ein wenig Humor. Aber achten Sie darauf, die Verständlichkeit nicht durch lustige Metaphern oder Ausdrücke zu beeinträchtigen. Wenn Sie nicht sicher sind, wie Sie dies ausbalancieren sollen, schreiben Sie einfach unkomplizierte Anleitungen und verwenden Sie den Tonfall in der Einleitung oder im Schluss.
  4. Erzählen Sie eine Geschichte. Sorgen Sie für einen Anfang, einen Mittelteil und ein Ende. Aber schreiben Sie keinen Roman (siehe Richtlinie Nr. 1).
    • Anfang: Dieser gibt dem Leser einen Kontext. Worum geht es in diesem Artikel und warum sollte es mich interessieren? Fassen Sie sich kurz.
    • Mittelteil: Die Anleitungen gehören hierher. Dieser sollte die Frage „Wie mache ich das?“ beantworten.
    • Ende: Gibt es weitere Schritte zum Artikel oder zur Funktion? Sagen Sie dem Leser, wohin er oder sie als Nächstes gehen sollte, wenn er oder sie mehr erfahren möchte.

Lesen Sie den nächsten Abschnitt für umfassendere Richtlinien.

Schreibstil (umfassend)

  • Konversationeller Schreibstil – Verwenden Sie einen informellen, aktiven Stil, ähnlich wie Sie mit jemandem persönlich sprechen würden.
  • Humor und Emotionen – Humor ist großartig, aber manchmal schwer oder unmöglich zu lokalisieren. Emotionen wie Überraschung und „Das wusste ich nicht/Heureka!“ sind möglicherweise einfacher einzubauen.
  • Mehrere Lernstile – Genau wie in der Schule lernen Menschen unterschiedlich. Außerdem profitiert jeder davon, wenn derselbe Inhalt auf verschiedene Weisen ausgedrückt wird.
  • Wiederholung – Wenn Sie etwas auf eine andere Weise mit verschiedenen Medien erklären, wiederholen Sie es offensichtlich auch, was eine weitere gute Möglichkeit ist, den Leuten zu helfen, sich an das Wichtige zu erinnern.
  • Bilder und Videos – Die Verwendung von Bildern und Videos zusammen mit Text ist nicht nur die nächstbeste Sache nach persönlicher Hilfe, sondern auch eine einfache Möglichkeit, mehrere Lernstile und Wiederholungen einzubeziehen. Zu viele Bilder können jedoch die Lokalisierung eines Artikels erschweren. Fügen Sie Bilder also nur dann hinzu, wenn sie für einen Schritt oder ein Konzept hilfreich sind. Für einen Schritt, bei dem eine Schaltfläche angeklickt wird, könnten Sie beispielsweise „Klicken Sie auf OK“ sagen, anstatt einen Screenshot des Dialogfelds dieser Schaltfläche hinzuzufügen.
  • Aktivitäten – Besonders in einem Tutorial ist es gut, den Leuten etwas Nützliches zu geben, das sie erreichen können. Es ist eine Sache, Anweisungen zu lesen und den Prozess zu verstehen, aber es ist oft hilfreich, die Leute daran zu erinnern und ihnen zu ermöglichen, Dinge auszuprobieren.

Artikeltypen

Die Verwendung konsistenter Inhaltstypen für unsere Wissensdatenbank-Artikel hat viele Vorteile, darunter eine einfachere Navigation und eine verbesserte Übersichtlichkeit und Organisation. Außerdem hilft es uns, Inhalte effektiver zu erstellen. Wir gehen dazu über, externe Wissensdatenbank-Artikel in vier Typen zu kategorisieren, von denen jeder einen bestimmten Zweck erfüllt:

  • Info: Diese Artikel befassen sich mit „Was ist…“-Fragen und liefern wesentliche Informationen, die den Lesern helfen, ein Thema zu verstehen.
  • Anleitung: Diese Artikel konzentrieren sich auf die Beantwortung von „Wie kann ich…“-Fragen und führen die Leser durch die Schritte, die erforderlich sind, um ein bestimmtes Ziel oder eine bestimmte Vorgehensweise zu erreichen.
  • Fehlerbehebung: Diese Artikel helfen den Nutzern bei der Identifizierung, Diagnose und Lösung häufiger Probleme, die bei einem Produkt, einer Dienstleistung oder einer Funktion auftreten können, indem sie „Wie kann ich…“-Fragen zur Problemlösung beantworten.
  • FAQ: Diese Artikel enthalten kurze Antworten auf häufig gestellte Fragen zu einem einzigen Thema, die möglicherweise nicht in andere einzelne KB-Artikel passen, und bieten eine schnelle Referenz für häufige Anfragen.

Beginnen Sie mit einem wirkungsvollen und beschreibenden Titel

Ein gut formulierter Titel ist mehr als nur eine Überschrift; er ist der erste Kontaktpunkt eines Nutzers mit Ihrem KB-Artikel. Ein guter Titel sollte nicht nur die Aufmerksamkeit des Lesers fesseln, sondern auch als knappe und informative Vorschau auf den Inhalt des Artikels dienen. Berücksichtigen Sie bei der Erstellung von Titeln für SUMO Folgendes:

  • Klarheit und Aussagekraft: Passen Sie den Titel an den Inhalt des Artikels und die Suchanfrage des Nutzers an. Seien Sie prägnant und dennoch nutzerorientiert.
  • Einbeziehung von Schlüsselwörtern: Integrieren Sie relevante Schlüsselwörter, um die Sichtbarkeit in Suchmaschinen zu verbessern und den Nutzern zu helfen, Ihren Artikel zu finden.
  • Prägnanz: Halten Sie Titel kurz, aber dennoch informativ. Kürzere Titel sind oft benutzerfreundlicher. Versuchen Sie, Titel auf etwa 60 Zeichen zu beschränken.
  • Handlungsorientiert: Verwenden Sie, wo zutreffend, handlungsorientierte Verben, um anzugeben, was Nutzer tun können, um ein Problem zu lösen oder ein Ziel zu erreichen. Vermeiden Sie Gerundien (Wörter, die auf „-ing“ enden) in Titeln, um sicherzustellen, dass sie handlungsorientiert bleiben. Vermeiden Sie Titel, die „Wie man…“ enthalten.

Schreiben Sie eine gute Einleitung

Zusammen mit dem Titel und dem Inhaltsverzeichnis hilft die Einleitung dem Nutzer zu entscheiden, ob er an der richtigen Stelle ist.

  • Für einen „Info“-Artikel: Geben Sie einen textlichen Überblick oder eine Definition des Konzepts und konzentrieren Sie sich darauf, warum es für den Nutzer wichtig ist.
  • Für einen „Anleitungs“-Artikel: Geben Sie einen textlichen Überblick oder eine Definition der Aufgabe und konzentrieren Sie sich auf die Wichtigkeit oder die Vorteile der Aufgabe.
  • Für einen „Fehlerbehebungs“-Artikel: Beschreiben Sie das spezifische Problem oder die Symptome, auf die Nutzer stoßen können. Schreiben Sie in klarer und prägnanter Sprache und vermeiden Sie nach Möglichkeit Fachjargon.

Denken Sie daran, dass eine gute Einleitung in der Regel auch als gute Zusammenfassung für die Suche dienen kann. Oft können Sie sie einfach in das Feld „Zusammenfassung für Suchergebnisse“ kopieren und sind fertig.

Strukturieren Sie den Artikel effektiv

Die allgemeine Idee hier ist, zu versuchen, Fähigkeiten von einfach bis komplex aufzubauen, während man versucht, die von den meisten Menschen benötigten Informationen am Anfang zu platzieren. Eine einfache, gängige Lösung sollte also in der Regel vor einer komplexen oder speziellen Lösung stehen.

Gestalten Sie Schritt-für-Schritt-Anleitungen leicht verständlich

Das Wichtigste, was Sie beim Schreiben von Schritt-für-Schritt-Anleitungen beachten sollten, ist, sorgfältig alle Aktionen aufzunehmen, die zur Erledigung der Aufgabe erforderlich sind. Wenn Sie beispielsweise nach der Auswahl einer Einstellung auf OK klicken müssen, um zum nächsten Schritt zu gelangen, stellen Sie sicher, dass das Klicken auf „OK“ als Teil dieses Schritts enthalten ist. Einige zusätzliche Dinge, die zu beachten sind:

  • Es gibt immer mehrere Wege, um ein Ergebnis zu erzielen. Wir sollten immer den benutzerfreundlichsten Weg wählen, indem wir nach Möglichkeit die grafische Benutzeroberfläche und Menüs verwenden.
  • Verwenden Sie ganze Sätze, wenn Sie den Zugriff auf die Benutzeroberfläche beschreiben.
  • Geben Sie bei Anweisungen erwartete Ergebnisse an (zum Beispiel: Klicken Sie auf „OK“ und das Fenster wird geschlossen.).

Lesbarkeit

Der Text muss lesbar sein. Dazu müssen Sie:

  • Einen Artikel in kleine logische/semantische Blöcke mit Unterüberschriften aufteilen.
  • Nummerierte Listen oder Aufzählungen verwenden.
  • Kurze oder relativ kurze Sätze schreiben.
  • Lange Absätze vermeiden.

Es gibt keine Begrenzung für die Textmenge. Je mehr Material, desto besser; Sie sollten es jedoch nicht künstlich erweitern. Geben Sie nur nützliche, wertvolle und notwendige Informationen an.

Wie man auf externe Dokumentation für Drittanbieter-Software verlinkt

Beim Erstellen oder Aktualisieren von Artikeln, die Aktionen in Drittanbieter-Software wie Betriebssystemen oder externen Anwendungen beinhalten, ist es entscheidend, den Nutzern genaue und zuverlässige Informationen zu liefern. Die Aufnahme direkter Schritte für diese Software in unsere Artikel kann jedoch Herausforderungen mit sich bringen:

  • Schnell veraltete Informationen: Updates von Drittanbieter-Software können unsere Anleitungen veralten lassen, was unsere Nutzer potenziell verwirren oder irreführen kann.
  • Ressourcenintensiv: Die kontinuierliche Überwachung und Aktualisierung von Schritten für mehrere externe Plattformen würde erheblichen Aufwand und Ressourcen erfordern, was möglicherweise nicht machbar ist.

Bewährte Praktiken

Um sicherzustellen, dass unsere Nutzer die zuverlässigsten und aktuellsten Informationen erhalten, ohne unsere Ressourcen zu überlasten, befolgen Sie diese bewährten Praktiken:

  • Auf offizielle Ressourcen verlinken: Wenn Anleitungen Drittanbieter-Software betreffen, suchen Sie die offizielle Dokumentation oder Hilfeartikel des Softwareherstellers. Verlinken Sie auf diese Ressourcen, anstatt die Schritte direkt in unseren Artikeln aufzuschreiben.
  • Kontext bereitstellen: Erklären Sie kurz, warum Sie den Nutzer auf eine externe Seite weiterleiten (zum Beispiel: „Für die neuesten und genauesten Schritte zur Anpassung Ihrer Systemeinstellungen, konsultieren Sie bitte die offizielle <Softwarename>-Supportseite“).
  • Links regelmäßig überprüfen: Obwohl wir den Wartungsaufwand für Anleitungen von Drittanbietern reduzieren wollen, ist es dennoch wichtig, regelmäßig zu überprüfen, ob externe Links noch gültig sind. Wenn Sie feststellen, dass ein Link veraltet oder defekt ist, suchen Sie nach einem aktualisierten Link zur offiziellen Dokumentation und reichen Sie eine Revision ein.
  • Haftungsausschluss für externe Inhalte: Wenn Sie Nutzer auf einen externen Link verweisen, machen Sie deutlich, dass sie SUMO verlassen und dass wir nicht für den Inhalt externer Websites verantwortlich sind. Ein einfacher Haftungsausschluss oder Hinweis kann ausreichen (zum Beispiel: „Wenn Sie diesem Link folgen, werden Sie auf eine externe Website weitergeleitet, die nicht von Mozilla betrieben wird.“).

Beispiel

Stellen Sie sich vor, Sie schreiben einen Artikel über die Konfiguration einer Firefox-Funktion, die eine Änderung der Systemeinstellungen auf einem Mac erfordert. Anstatt die Schritte direkt im Artikel zu beschreiben, könnten Sie schreiben:

Für die neuesten Schritte zur Anpassung Ihrer Systemeinstellungen unter macOS konsultieren Sie bitte die offizielle Apple-Supportdokumentation, indem Sie diese Anleitung besuchen. Bitte beachten Sie, dass Sie durch Folgen dieses Links auf eine externe Website weitergeleitet werden, die nicht von Mozilla betrieben wird.

Dies stellt sicher, dass Sie den aktuellsten Anweisungen direkt von der Quelle folgen.

Technische Richtlinien

Titel

  • Titellänge: Die Suchergebnisseite von Google zeigt bis zu 60 Zeichen an. Ihr Titel kann bei Bedarf länger sein, aber stellen Sie sicher, dass Ihre wichtigen Schlüsselwörter in den ersten 60 Zeichen enthalten sind.
  • Großschreibung: Das erste Wort im Titel sollte großgeschrieben werden, ebenso wie Eigennamen und Namen, nicht jedes wichtige Wort. Verwenden Sie den „Satzstil“, nicht den „Überschriftenstil“. (Dasselbe gilt für Überschriften. Siehe den Abschnitt Stilrichtlinien und Textregeln unten für weitere Regeln zur Großschreibung.) Bearbeiten Sie jedoch nicht den Titel eines bestehenden Artikels, um die Großschreibung zu ändern, es sei denn, Sie nehmen andere Titeländerungen vor, da keine Weiterleitung erstellt wird und dies zu defekten Wiki-Links in Artikeln führt, die dorthin verlinken (Bug 1969540).
  • Verwenden Sie keinen Doppelpunkt im Artikeltitel, da dies das Erstellen eines Wiki-Links zu diesem Artikel verhindert (Bug 749835). Stellen Sie außerdem sicher, dass Sie keine zusätzlichen Leerzeichen im Artikeltitel haben, da dies ebenfalls verhindert, dass Wiki-Links funktionieren.
  • Versuchen Sie, die Benennung von Artikeln zu variieren. Verwenden Sie nicht in jedem Titel dieselben Wörter oder Phrasen. Beginnen Sie Artikel zum Beispiel nicht immer mit „Wie“ und vermeiden Sie Aufgabennamen mit „-ing“ wie „Setting the home page“ (Festlegen der Startseite).
  • Denken Sie daran, dass nicht die gesamte Erklärung in den Titel muss. Sie können die Zusammenfassung verwenden, um dem Nutzer zusätzliche Informationen über den Inhalt des Artikels zu geben.

Slug

Wenn Sie einen neuen Artikel erstellen und einen Titel eingeben, erstellt SUMO automatisch einen Slug (den Teil nach kb/ am Ende der URL für den Artikel). Ein Reviewer kann den Titel eines bestehenden Artikels bearbeiten, aber der Slug bleibt derselbe, es sei denn, er wird manuell geändert (dies ist beabsichtigt). Der Slug hat eine Längenbeschränkung von 50 Zeichen. Leerzeichen werden als Bindestriche dargestellt. Der Slug sollte mit dem Titel übereinstimmen, muss aber aufgrund der engeren Platzbeschränkung nicht identisch sein.

Den Slug korrigieren

Überprüfen Sie unbedingt das Ende des automatisch generierten Slugs. Manchmal wird ein Wort abgeschnitten oder es endet mit einem Bindestrich. Bitte korrigieren Sie solche Dinge.

Slug eines bestehenden Artikels aktualisieren

Wenn Sie den Titel eines bestehenden Artikels aktualisieren, lassen Sie den aktuellen Slug unverändert, es sei denn, der neue Titel stellt eine wesentliche Änderung dar, die nicht mehr mit dem bestehenden Slug übereinstimmt. Die Beibehaltung eines konsistenten Slugs hilft, defekte Links zu vermeiden und den SEO-Wert zu erhalten.

Kategorien, Produkte und Themen

Meistens gehört ein Artikel entweder in die Kategorie Anleitung oder Fehlerbehebung. Gelegentlich schreiben wir Artikel in einer der anderen Kategorien, wie z. B. „Wie man mitwirkt“-Artikel (wie diesen hier). Die Verlaufsseite des Artikels zeigt die Kategorie an.

Artikel sind auch für mindestens ein Produkt „relevant“. Sie gehören auch zu einem Haupt-„Thema“ und optional zu einem „Unterthema“.

Hinweis: Bitte beachten Sie, dass die Kategorie Administration Artikel vor öffentlichen Suchen verbirgt, aber dennoch den Zugriff per URL ermöglicht. Verwenden Sie diese Kategorie, wenn Sie Inhalte konfigurieren, die vorübergehend verborgen bleiben sollen. Dies kann beispielsweise für Artikel nützlich sein, die sich auf eine bevorstehende Firefox-Version beziehen, die lokalisiert werden müssen, aber im Moment nicht in öffentlichen Suchen auffindbar sein sollen. Artikel können bei Bedarf in eine andere Kategorie verschoben werden, indem die Metadaten des Artikels bearbeitet werden, wie in diesem Artikel erklärt.

Schlüsselwörter

Das Schlüsselwörter-Feld in einem Artikel kann verwendet werden, um die Suchergebnisse auf SUMO zu verbessern. Es sollte jedoch nur unter bestimmten Umständen verwendet werden, da ein Missbrauch die Suche tatsächlich beeinträchtigen kann. Wir müssen selten Schlüsselwörter verwenden. Einzelheiten finden Sie unter When and how to use keywords to improve an article's search ranking.

Schreiben Sie eine gute Zusammenfassung für die Suche

Die Artikelzusammenfassung hilft den Nutzern zusammen mit dem Titel zu beurteilen, ob ein Artikel ihre Frage beantworten wird. Wir nennen dies „Nutzervertrauen“ und es wirkt sich direkt auf die Klickraten aus. Selbst wenn wir den richtigen Artikel ganz oben in der Suchergebnisliste anzeigen, muss der Nutzer die gedankliche Verbindung zwischen der Suchanfrage und den von uns angezeigten Ergebnissen herstellen, damit er auf den Artikel klickt.

Eine Zusammenfassung für einen Anleitungsartikel sollte die im Artikel behandelten Themen enthalten. Ein Fehlerbehebungsartikel sollte versuchen, Symptome zu nennen. Darüber hinaus sollte eine Zusammenfassung diesen Richtlinien folgen:

  • Kurz und auf den Punkt gebracht. Erinnern Sie sich an Kleinanzeigen? Schreiben Sie es so. Suchmaschinen können alles, was länger als 140 Zeichen ist, abschneiden. Wenn Sie eine längere Zusammenfassung verwenden, halten Sie die wichtigen Informationen am Anfang. Hinweis: Die KB-Software zeigt 20 verbleibende Zeichen an, wenn die Zusammenfassung 140 Zeichen erreicht, da das interne Suchlimit 160 beträgt.
  • Verwenden Sie kein Wiki-Markup.
  • Verwenden Sie nicht in jeder Zusammenfassung „Dieser Artikel erklärt“. Variieren Sie, wenn möglich. Einige andere Phrasen, die Sie in Betracht ziehen können:
    • Wir zeigen Ihnen
    • Wir erklären
    • Diese Seite erklärt
    • Dieser Artikel beschreibt
    • Erfahren Sie, wie

Anzahl der Schritte

Wenn Sie Nutzer durch einen Prozess führen, ziehen Sie geordnete Listen (nummerierte Listen) in Betracht. Es ist im Allgemeinen eine gute Praxis, zu versuchen, die Gesamtzahl der Schritte im Bereich von sechs bis sieben zu halten.

Parallele Struktur

Verwenden Sie für jeden Schritt, den Sie schreiben, die gleiche Formulierung oder das gleiche Wortmuster. Eine parallele Struktur ist in KB-Artikeln wichtig, weil sie die Dinge klar und leicht verständlich macht. Wenn ähnliche Elemente ein konsistentes Format haben, können Nutzer Aufgaben reibungsloser verstehen und erledigen. Diese Struktur vereinfacht Anweisungen, reduziert Fehler und stellt sicher, dass Informationen effektiv vermittelt werden.

Zum Beispiel:

  1. Suchen Sie nach Chronik löschen, wenn Firefox geschlossen wird. Wenn dies ausgewählt ist:
    1. Klicken Sie auf die Schaltfläche Settings….
    2. Stellen Sie sicher, dass Formular- & Suchchronik nicht ausgewählt ist.
    3. Klicken Sie auf OK.

Richtungsangaben

Richtungsangaben sind Verweise oder Indikatoren, die Nutzer zu dem spezifischen Ort oder der Position innerhalb einer Benutzeroberfläche führen, an der sie eine bestimmte Aktion ausführen müssen. Diese Hinweise helfen den Nutzern, effektiver in Software, Anwendungen oder auf Websites zu navigieren und zu interagieren. Sie umfassen typischerweise Phrasen wie „In der oberen rechten Ecke“, „Im linken Menü“ oder „Unter der Suchleiste“, die den Nutzern ein klares Gefühl dafür geben, wo sie Aktionen finden und ausführen können.

Stellen Sie in Ihren KB-Artikelanweisungen sicher, dass Sie Richtungsangaben vor der Aktion machen. Sagen Sie zum Beispiel nicht Klicken Sie auf die Schaltfläche, sondern Klicken Sie in der oberen rechten Ecke auf die Schaltfläche. Dieses Format hilft den Nutzern, Aktionen innerhalb der Benutzeroberfläche leicht zu finden und auszuführen.

Stilrichtlinien und Textregeln

Wie bereits erwähnt, sollten Sie beim Schreiben einen aktiven, konversationellen Stil verwenden. Vermeiden Sie Formulierungen wie „Wenn die Lesezeichen eines Nutzers verloren gegangen sind“ und sagen Sie stattdessen „Wenn Sie Ihre Lesezeichen verloren haben“. Hier sind weitere häufige Stil- und Textprobleme, auf die Sie beim Schreiben von Support-Artikeln stoßen können: Verwenden Sie Begriffe immer so, wie sie in der Mozilla-Benutzeroberfläche erscheinen. Zum Beispiel:

  • Plugins hat keinen Bindestrich.
  • Add-ons hat einen Bindestrich.
  • Home page (Startseite) besteht aus zwei Wörtern.

Allgemeine Computerbegriffe:

  • Website ist ein Wort. Web page (Webseite) besteht aus zwei Wörtern.
  • Log in und log out sind Verben. Beispiel: „Log in to the website.“ (Melden Sie sich auf der Website an). Dasselbe gilt für sign in und sign out. Verwenden Sie nicht „log into“ oder „sign into“.
  • Login und logout sind Substantive (normalerweise als Adjektive verwendet). Beispiel: „Click the login button.“ (Klicken Sie auf die Login-Schaltfläche).
  • Verwenden Sie email anstelle von e-mail.
  • Der Plural von CD-ROM ist CD-ROMs.

Links zu mozilla.org und firefox.com sollten keine Sprachkennung enthalten:

Wenn Sie Links in Sätze einbauen:

  • Vermeiden Sie „hier klicken“ oder „hier“ als Linktext.
    • Richtig: Gehen Sie zu Ihren Kontoeinstellungen, um Ihr Abonnement zu kündigen.
    • Falsch: Klicken Sie hier, um Ihr Abonnement zu kündigen.

Schreiben Sie die folgenden Elemente groß:

  • Eigennamen und Namen, einschließlich Markennamen, Produktnamen und Funktionsnamen
  • Das erste Wort eines vollständigen Satzes
  • Die Buchstaben von Abkürzungen und Akronymen, es sei denn, sie sind normalerweise kleingeschrieben
  • Das erste Wort in nummerierten Listen oder Aufzählungen
  • Der Name einer Taste auf der Tastatur
  • Das erste Wort eines vollständigen Satzes nach einem Doppelpunkt
  • Das erste Wort in einer Überschrift oder einem Titel

Mozilla accounts:

  • Das „a“ in Mozilla accounts wird immer kleingeschrieben, außer in Navigationselementen, wo es zusammen mit anderen Navigationselementen steht, die die Großschreibung von Überschriften verwenden.
  • Verwenden Sie immer „sign in“ und „sign out“.
  • In Verbform verwenden Sie „sign in to your account“ (nicht „sign into“), um grammatikalisch korrekt zu sein.
  • Sie können auch „Sign in with Mozilla“ verwenden.
  • „Sign“ sollte immer als Verb verwendet werden. Wenn Sie es als Substantiv verwenden, benutzen Sie „login“.
  • Verwenden Sie „sign up“ als Handlungsaufforderung, um ein neues Konto zu erstellen.

Einzelheiten zur Bezeichnung von Mozilla accounts in KB-Artikeln finden Sie unter Editorial guidelines for Mozilla accounts.

Verwenden Sie nicht „i.e.“ und „e.g.“. Diese lateinischen Abkürzungen können die Leute verwirren. Verwenden Sie aus Gründen der Klarheit „mit anderen Worten“ oder „anders ausgedrückt“ anstelle von i.e., wenn Sie etwas auf eine andere Weise erklären möchten. Verwenden Sie „zum Beispiel“ oder „wie“ anstelle von e.g., wenn Sie Beispiele geben möchten.

Verwenden Sie keine seriellen Kommas in einer Liste von Elementen. Verwenden Sie zum Beispiel „Erweiterungen, Themes und Plugins“ (ohne das serielle Komma), nicht „Erweiterungen, Themes, und Plugins“.

Verwenden Sie Initialwörter, die als allgemein verständlich gelten. Zum Beispiel:

  • HTTP
  • USB
  • URL

Zahlen, die in der Version eines Produkts, in Fehlercodes, Tasten und Schaltflächen vorkommen, werden nicht ausgeschrieben.

Schreiben Sie Anweisungen im Aktiv. Aktiv und Präsens vereinfachen Anweisungen, machen sie leichter verständlich und fördern schnelles Handeln. Beispiel:

„Starten Sie Firefox neu, um zu aktualisieren“ nicht „Firefox muss neu gestartet werden“.

Schreiben Sie Backslashes (\\) und Schrägstriche (/) für Pfade und Suchen aus, um Verwirrung zu vermeiden.

Beispiel: „Einige Pfadnamen zu Bildern enthalten Backslashes (\\)“.

Tastenkombinationen Schreiben Sie den ersten Buchstaben einer Tastenkombination oder einer Kombination von Tastenkombinationen groß: Ctrl + Shift + C oder Command + Shift + C.

Verwenden Sie keine Umgangssprache und Redewendungen. Alle unsere Artikel werden in viele verschiedene Sprachen übersetzt, daher werden sie von Nicht-Muttersprachlern des Englischen gelesen und übersetzt. Umgangssprache und Redewendungen können mehrdeutig sein, was die Leser verwirren und die Übersetzung erschweren kann.

Wir haben spezielle visuelle Stile für eine Reihe von Elementen, die durch Hinzufügen des richtigen Wiki-Markups um das Element herum erreicht werden können. Siehe die Markup-Spickzettel für die gebräuchlichsten Stile.

Wir haben ein spezielles Wiki-Markup – {for} – das es Ihnen ermöglicht, Informationen gezielt für bestimmte Versionen von Firefox oder bestimmte Betriebssysteme bereitzustellen. Zum Beispiel können Sie eine Reihe von Anweisungen für Personen anzeigen, die Windows verwenden, und eine andere für Personen, die macOS verwenden (siehe Verwendung von „For“-Tags für Details).

Diese netten Menschen haben geholfen, diesen Artikel zu schreiben:

Illustration of hands

Mitmachen

Vergrößern und teilen Sie Ihr Fachwissen mit anderen. Beantworten Sie Fragen und verbessern Sie unsere Wissensdatenbank.

Weitere Informationen