Wie Wissensdatenbank-Artikel geschrieben werden

Viele Dinge müssen beachtet werden, wenn Artikel der Mozilla-Hilfe (SuMo = support.mozilla.org) geschrieben, übersetzt oder bearbeitet werden: Sie sollen zugleich vollständig und kurzgefasst, sachlich und spannend sein. Das ist sicher nicht die einfachste Sache der Welt. Mithilfe dieser Anleitung gelingt dir dieser Balanceakt ein bisschen leichter. Außerdem ist das hier ein Wiki und wir können alles korrigieren, falls wir irgendwo etwas falsch gemacht haben oder verbessern können.

Schreibe für die breite Masse von technisch unerfahrenen Lesern

Wir möchten, dass unsere Artikel von jedem Leser, also nicht nur erfahrenen Nutzern, verwendet werden können. Das bedeutet, dass wir für ein allgemeines Publikum schreiben und nicht für Leute, die sich mit Computertechnik oder Fachbegriffen auskennen. Nimm an, dass die Person, für die du schreibst, nicht weiß, wie sie Einstellungen ändern oder ein Symbol zur Navigations-Symbolleiste hinzufügen kann, und dafür eine detaillierte Schritt-für-Schritt-Anleitung benötigt. Weiterhin sollten wir davon ausgehen, dass der Leser keine Änderungen irgendwelcher Art vorgenommen hat und sich die Anwendung und das Betriebssystem in der Standard-Konfiguration befinden.

Finde einen guten Titel

Der Titel des Artikels ist neben der Zusammenfassung die einzige Information und zugleich Entscheidungshilfe für unsere Nutzer, ob der Artikel ihre Frage beantworten könnte. Wir nennen das „Nutzervertrauen“, welches die Klicks direkt beeinflusst. Auch wenn der richtige Artikel in den Suchergebnissen ganz oben steht, muss der Nutzer diesen als richtige Lösung für sein Problem erkennen.

Der Artikel-Titel sollte grob beschreiben, worum es in dem Artikel geht. Die ersten Worte sollen so verständlich wie möglich sein und wichtige Schlüsselwörter enthalten. Dadurch können Nutzer erkennen, worum es in dem Artikel geht, und somit auf den richtigen Artikel klicken. Zusätzlich sollte ein Titel diese Richtlinien einhalten:

• Titellänge: Googles Suchergebnis-Seite zeigt bis zu 70 Zeichen an. Wenn nötig kann der Titel auch länger sein, aber die wichtigsten Schlüsselwörter sollten in den ersten 70 Zeichen enthalten sein.
• Großschreibung: Bitte beachte: Dieser Punkt betrifft nur englischsprachige Artikel, da die Großschreibung in der deutschen Sprache eindeutig geregelt ist. Im Abschnitt SUMO-Stilanleitung findest du weitere nützliche Hinweise.

In englischen Artikeln: Nur das erste Wort und Substantive im Titel sollten groß geschrieben werden, nicht jedes wichtige Wort. Verwende bei der Schreibweise den „Satz“-Stil, nicht den „Überschriften“-Stil (Anleitung in englischer Sprache).

• Verwende im Titel keine Doppelpunkte, da diese das Erstellen eines Wiki-Links verhindern (bug 749835).
• Stelle sicher, dass der Titel keine zusätzlichen Leerzeichen enthält. Dadurch würden Wiki-Links ebenfalls nicht funktionieren.
• Variiere in den Artikelnamen und verwende nicht immer dieselben Verben und Satzteile.
• In englischen Artikeln: Vermeide die Verwendung von „-ing“-Wörtern.

Bedenke, dass der Titel nicht aus der gesamten Beschreibung bestehen muss. Mithilfe der Zusammenfassung kannst du dem Nutzer genauere Informationen über den Inhalt des Artikels geben.

URL anpassen

Wenn du einen Titel schreibst, erstellt SUMO automatisch eine URL-Endung. Diese darf maximal 50 Zeichen haben. Leerzeichen werden hier zu Strichen. Die URL-Endung sollte dem Titel ähneln, muss aber nicht ganz identisch sein. Überprüfe vor allem das Ende der automatisch generierten URL. Manchmal wird hier ein Wort abgeschnitten oder es endet mit einem Strich. Bitte ändere solche Stellen entsprechend.

Kategorien, Produkte und Themen

Größtenteils gehören die Artikel in die Kategorien Anleitung oder Fehlerbehebung. Gelegentlich schreiben wir auch Artikel für die Kategorie „Wie Sie mithelfen können“ (wie dieser hier) oder für eine der anderen Kategorien.

Artikel beziehen sich auch auf mindestens ein Produkt. Außerdem gehören sie zu einem „Thema“ und manchmal noch zu einem „Unterthema“.

Schlüsselwörter

Das Schlüsselwörter-Feld in Artikeln kann zur Verbesserung der Suchergebnisse auf SUMO verwendet werden. Dazu sollten aber bestimmte Voraussetzungen vorliegen, da eine falsche Verwendung der Suche schaden kann. Wir brauchen selten Schlüsselwörter. Weitere Informationen dazu erhältst du im Artikel When and how to use keywords to improve an article's search ranking.

Erstelle eine gute Suchmaschinen-Zusammenfassung

Die Zusammenfassung eines Artikels ist neben dem Titel die einzige Information und zugleich Entscheidungshilfe für unsere Nutzer, ob der Artikel ihre Frage beantworten könnte. Wir nennen das „Nutzervertrauen“, welches die Klicks direkt beeinflusst. Auch wenn der richtige Artikel in den Suchergebnissen ganz oben steht, muss der Nutzer diesen als richtige Lösung für sein Problem erkennen.

Die Zusammenfassung einer Anleitung sollte alle angesprochenen Themengebiete enthalten. Ein Fehlerbehebungs-Artikel sollte auch Symptome beschreiben. Zusätzlich sollten bei einer Zusammenfassung folgende Richtlinien beachtet werden:

• Kurz und direkt. Kennst du Kleinanzeigen? Nimm sie als Vorbild, denn manche Suchmaschinen schneiden alle Textteile ab, die länger als 140 Zeichen sind. Benötigst du mehr Zeichen für die Zusammenfassung, dann stelle sicher, dass die wichtigen Informationen am Anfang stehen.
  Achtung: Die Software der Wissensdatenbank-Artikel wird bei Erreichen von 140 Zeichen immer noch eine Verfügbarkeit von 20 weiteren Zeichen anzeigen, da die interne Suchbegrenzung nach wie vor 160 Zeichen beträgt.
• Verwende keine Wiki-Markups.
• Verwende nicht in jeder Zusammenfassung den Ausdruck „Dieser Artikel erklärt” („This article explains“). Variiere ihn, wenn möglich, z. B. mit:
  • „Wir zeigen Ihnen” (We'll show you)
  • „Wir erklären” (We'll explain)
  • „Diese Seite erklärt” (This page explains)
  • „Dieser Artikel beschreibt” (This article describes)
  • „Erfahren Sie, wie” (Learn how)
  • „Wir lehren Sie”
  • „Lesen Sie hier“

Wecke Aufmerksamkeit

Die Wissensdatenbank ist eine Sammlung von technischen Informationen über den Umgang mit den Mozilla-Anwendungen. Die Dokumentation beschreibt die vielfältigen Funktionen, zeigt Vorgehensweisen zur Fehlersuche und gibt Anleitungen zum Beheben verbreiteter Probleme. Die Dokumentation kann über die Suchfunktion auf jeder Seite erreicht werden oder du kannst deinen Rechner auch einfach durch den Raum werfen, wo Einhörner ihre Regenbogenkraft nutzen, um ihn in eine magische Süßigkeit zu verwandeln, die – einmal konsumiert – dich zu einem Stufe-70-Computer-Ninja machen wird.

Bist du nun munter? Gut.

Denn dieser Absatz klang nach einer ziemlich langweiligen Lektüre – zumindest bis zum Teil mit den Einhörnern. Mit etwas Humor, Emotionen (ÜBERRASCHUNG!) und ähnlichen Schreibtechniken können wir versuchen, die Leute vom Einschlafen oder Wegklicken abzuhalten. Die folgenden Tipps sollen dir helfen, Artikel so zu schreiben, als würdest du mit dem Leser persönlich sprechen. Dadurch wird die Information leichter verstanden und der Leser kann sich besser daran erinnern.

• Gesprächsstil – Verwende im Englischen einen ungezwungenen und im Deutschen einen höflichen („Sie”) und aktiven Gesprächsstil, ähnlich einem real geführten Gespräch mit jemandem.
• Humor und Emotion – Humor einzusetzen kann in englischsprachigen Artikeln durchaus angebracht sein, ist aber oftmals schwer zu übersetzen. Im Deutschen vermeiden wir z. B. einen kumpelhaften Ton. Emotionen wie „Überraschung” und „Ich wusste das nicht!” (welche Emotion das auch sein mag) sind vielleicht einfacher einzubauen.
• Mehrere Lernmethoden – Wie in der Schule so lernen auch hier die Leute unterschiedlich. Auch profitieren alle davon, wenn derselbe Inhalt auf verschiedene Weise ausgedrückt wird.
• Wiederholung – Wenn du etwas mit verschiedenen Mitteln auf unterschiedlichem Wege erklärst, wiederholst du dich (offensichtlich). Das ist eine gute Möglichkeit, den Lesern dabei zu helfen, sich an die wichtigen Dinge zu erinnern.
• Grafiken und Videos – Verwende Grafiken (z. B. Bildschirmfotos) und Videos, um den erklärenden Text zu unterstützen und zu wiederholen. Damit wird das Ganze grafisch aufgewertet und kann leichter verstanden werden.
• Aktivitäten – Besonders bei Anleitungen ist es gut, die Leser selbst eine sinnvolle Aufgabe ausführen zu lassen. Es ist eine Sache, eine Anleitung zu lesen und den Vorgang zu verstehen, aber oft hilft es viel mehr, die Leser einzubinden und zu ermutigen, etwas selbst auszuprobieren.

Beginne mit einer guten Einleitung

Zusammen mit dem Titel und dem Inhaltsverzeichnis ist die Einleitung wichtig, da der Leser damit rasch prüfen kann, ob er hier richtig ist.

• Für eine Anleitung: Beschreibe in einer kurzen Zusammenfassung, was in dem Artikel gelernt werden kann.
• Für einen Referenzartikel: Erkläre kurz die beschriebene Funktion.
• Für Artikel zur Fehlersuche und -behebung: Beschreibe in einer kurzen Zusammenfassung das Problem und dessen Symptome.

Eine gute Einleitung eignet sich normalerweise zugleich als Zusammenfassung für die Suchfunktion. Oft kannst du sie einfach unverändert in das Textfeld „Zusammenfassung der Suchergebnisse” kopieren.

Artikel effektiv aufbauen

Grundsätzlich sollen die im Artikel gelernten oder geforderten Fähigkeiten ansteigen. Beginne mit den einfachen und beende mit den komplizierten Möglichkeiten, wobei die von den meisten Lesern benötigen Informationen dabei möglichst am Artikelanfang stehen. Eine einfache und allgemeine Problemlösung wird deshalb zuerst angeboten, danach erst folgt ein kompliziertes und umfangreiches Verfahren.

Verwende aussagekräftige Überschriften

Unsere Artikel sind meistens umfangreich, wodurch klare Überschriften wichtig sind, damit die Nutzer schnell die für sie relevanten Stellen finden. Wirf einen Blick auf das Inhaltsverzeichnis. Liefert es einen guten Überblick über den Artikelumfang und passt es zur Zusammenfassung?

Schritt-für-Schritt-Anleitungen leicht verständlich gestalten

Bei Schritt-für-Schritt-Anleitungen musst du besonders darauf achten, immer gewissenhaft sämtliche Aktionen einzubeziehen, die benötigt werden, um die Aufgabe vollständig zu erfüllen. Wenn z. B. nach dem Festlegen einer Auswahl auf „OK” geklickt werden muss, um zum nächsten Schritt zu gelangen, so muss dieser Klick auf „OK” auch ein Teil des Anleitungsschritts sein.

Weitere Dinge, die du beachten sollst:

• Es gibt immer mehrere Wege, um ans Ziel zu gelangen. Wähle – soweit möglich – immer den benutzerfreundlichsten Weg, z. B. über die grafische Benutzeroberfläche und die Menüs anstatt über Tastenkürzel.
• Verwende vollständige Sätze, wenn du den Zugriff auf die Benutzeroberfläche beschreibst.
• Baue erwartete Resultate ein, wenn du eine Anleitung schreibst (z. B.: Klicke auf „OK” und das Fenster wird sich schließen.).

SUMO-Stilanleitung

Wie bereits erwähnt, sollst du beim Schreiben einen aktiven Kommunikationsstil verwenden. Vermeide Texte wie "Wenn die Lesezeichen des Benutzers verloren gehen ..." und schreibe stattdessen "Wenn Sie Ihre Lesezeichen verloren haben ...".

Weitere wichtige Stilvorgaben zum Schreiben von Hilfeartikeln:

Übernimm die Begriffe genauso, wie sie in der Benutzeroberfläche von Mozilla geschrieben sind. Beispiel:

• Plugins hat keinen Bindestrich.
• Add-ons hat einen Bindestrich.
• Englische Begriffe wie Home page bestehen aus zwei Wörtern. Im Deutschen werden Wortzusammensetzungen immer zusammen geschrieben (Startseite) oder mit Bindestrich verbunden (Navigations-Symbolleiste).

Übliche technische Begriffe:

• Internet wird im Englischen wie auch im Deutschen groß geschrieben.
• Website ist ein zusammengesetztes Wort (auch im Englischen) und bezeichnet eine vollständige Internetpräsenz. Webseite dagegen bezeichnet eine einzelne Seite einer Internetpräsenz.
• Log in und log out sind im Englischen Zeitwörter, z. B. "Log in to the website". Im Deutschen schreiben wir anmelden und abmelden.
• Login und logout sind im Englischen Hauptwörter (oft werden sie als Eigenschaftswörter verwendet), z. B. "Click the login button". Im Deutschen schreiben wir Anmeldung und Abmeldung oder in Zusammensetzungen z. B. Anmelde-Schaltfläche.
• Das erstmalige Hinterlassen von Anmeldedaten nennen wir registrieren statt anmelden.
• Schreibe im Englischen email statt e-mail. Im Gegensatz dazu ist im Deutschen die korrekte Bezeichnung E-Mail.
• Die Mehrzahl von CD-ROM ist CD-ROMs ohne Apostroph. Das gilt auch für alle anderen Begriffe im Deutschen wie im Englischen.

Verweise auf mozilla.org dürfen keine bestimmte Sprache enthalten:

• Verwende https://www.mozilla.org/ anstatt https://www.mozilla.org/de/, weil die richtige Sprache für den Anwender durch die Browsereinstellung gewählt wird.

Schreibe Folgendes groß:

• Hauptwörter
• Das erste Wort eines vollständigen Satzes
• Die Buchstaben von Abkürzungen und Akronymen, außer sie werden üblicherweise klein geschrieben
• Das erste Wort in Aufzählungen oder nummerierten Listen
• Den Namen einer Taste auf der Tastatur
• Das erste Wort eines vollständigen Satzes, das auf einen Doppelpunkt folgt
• Das erste Wort einer Überschrift oder eines Artikeltitels

Um einen falschen Gebrauch der beiden Abkürzungen „i.e.” und „e.g.” in englischen Artikeln zu verhindern, vermeide deren Benutzung soweit möglich. Falls sie dennoch erforderlich sind, verwende sie so wie in dieser englischen Erklärung beschrieben.

Zur besonderen grafischen Darstellung bestimmter Elemente steht uns eine Reihe unterschiedlicher Wiki-Auszeichnungen zur Verfügung. Eine vollständige Liste findest du in der Syntaxübersicht.

Eine ganz besondere Wiki-Auszeichnung – {for} – erlaubt uns, bestimmte Informationen nur für bestimmte Firefox-Versionen und Betriebssysteme sichtbar zu machen.
Beispielsweise kann ein bestimmter Informationsteil nur Windows-Nutzern angezeigt werden, und Mac OS X-Nutzer sehen an der gleichen Stelle den für sie relevanten Teil. Weitere Informationen darüber erhältst du im For-Artikel.