Wie Wissensdatenbank-Artikel geschrieben werden

Viele Dinge müssen beachtet werden, wenn Artikel geschrieben, übersetzt oder bearbeitet werden: vollständig und kurzgefasst, sachlich und fesselnd – und alles gleichzeitig. Das ist sicherlich nicht das einfachste von der Welt. In dieser Anleitung findest du Hilfen, wie du diesen Balanceakt ein bisschen leichter meistern kannst. Außerdem ist das hier ein Wiki und wir können alles korrigieren, falls wir irgendwo etwas falsch gemacht haben oder verbessern können.

Für wen schreiben wir Artikel?

Wir möchten, dass die Firefox-Hilfe von allen Nutzern von Firefox verwendet werden kann. 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. Weiters sollten wir davon ausgehen, dass der Leser keine Änderungen irgendwelcher Art vorgenommen hat und sich Firefox und das Betriebssystem in der Standard-Konfiguration befinden.

Einen guten Titel finden

Wenn wir einen Titel für einen Artikel suchen, müssen wir versuchen, das zu treffen, wonach die Leute suchen und im Internet stöbern. Es sollte zur Frage passen, die der Hilfesuchende dir persönlich stellen würde. Hier sind einige Beispiele für gute Titel:

  • Für eine Anleitung: Wie erreiche ich dieses Ziel? (z.B. Wie lege ich die Startseite fest?)
  • Für einen Referenzartikel: Was ist Funktion sowieso? (z.B. Was sind App-Tabs?)
  • Für Artikel zur Fehlerbehebung: Das ist das Problem, das ich habe. (z.B. Die Startzeit von Firefox ist lang)

Techniken, um eine Anleitung fesselnd zu schreiben

Die Firefox-Hilfe ist eine Sammlung von technischen Informationen über den Umgang mit dem Webbrowser Firefox. Die Dokumentation listet die Aufgaben der Funktionen von Firefox auf und erklärt Wege zum Beheben verbreiteter Probleme. Die Dokumentation kann auch über die Suchfunktion auf jeder Seite betreten 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.

Dieser Absatz klang nach einer langweiligen Lektüre – zumindest bis zu dem Teil mit den Einhörnern. Mit etwas Humor und Emotionen (ÜBERRASCHUNG!) und ähnlichen Techniken können wir versuchen, die Leute vom Einschlafen oder Wegklicken abzuhalten. Diese Techniken, die nun aufgelistet werden, haben das Ziel, dich dahingehend zu trainieren, dass die Interaktion mit dem Leser immer so sein sollte, als würden der Leser und du miteinander sprechen. Damit soll die Information leichter verstanden werden und der Leser soll 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 zu verwenden ist im Englischen großartig, ist aber oftmals schwer zu übersetzen. Im Deutschen vermeiden wir z.B. einen kumpelhaften Tonfall. 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, den selben Inhalt auf verschiedene Weise ausgedrückt zu sehen.
  • Wiederholung – Wenn du etwas mit verschiedenen Mitteln auf unterschiedlichem Wege erklärst, wiederholst du dich (offensichtlich), was eine andere gute Art ist, den Leuten 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 in Anleitungen ist es gut, den Leuten etwas Sinnvolles zum selber Ausführen zu geben. Es ist das eine, eine Anleitung zu lesen und den Vorgang zu verstehen, aber es ist oft hilfreich, die Leute daran zu erinnern, etwas selbst auszuprobieren.

Der Artikel Startseite festlegen ist ein gutes Beispiel für die Anwendung dieser Techniken.

Eine gute Einleitung schreiben

Zusammen mit dem Titel und dem Inhaltsverzeichnis ist die Einleitung wichtig, um dem Leser kurz die Möglichkeit zu geben zu überprüfen, ob er hier richtig ist

  • Für eine Anleitung: Erkläre in einer kurzen Zusammenfassung, was in dem Artikel gelernt werden kann.
  • Für einen Referenzartikel: Erkläre in einer kurzen Zusammenfassung die beschriebene Funktionalität.
  • Für Artikel zur Fehlerbehebung: Erkläre in einer kurzen Zusammenfassung das Problem und dessen Symptome.

Eine gute Einleitung kann normalerweise eine gute Zusammenfassung für eine Suchfunktion sein. Oftmals kannst du sie einfach in das „Zusammenfassung für der Suchergebnisse̶ kopieren und fertig.

Der Aufbau von Artikeln

Grundsätzlich sollen die Fähigkeiten, die im Artikel gelernt oder gefordert werden, von erst einfach bis dann zu komplex ansteigen. Dabei sollen die Informationen, die die meisten Leute benötigen, nahe am Beginn des Artikels stehen. Eine einfache, geläufige Lösung eines Problems soll deshalb üblicherweise vor einer komplizierteren Lösung stehen.

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

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

Weitere Dinge, die du beachten sollst:

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

Hier nun ein Beispiel aus dem Artikel Startseite festlegen mit Erklärungen in Klammern.

Festlegen, welche Seiten Firefox beim Starten anzeigen soll
(Die Überschrift – erklärt, wofür die folgende Anleitung gut ist.

Diese großartige Funktion können Sie zusätzlich zu Ihren Startseite-Einstellungen verwenden. Um Zeit zu sparten, können Sie Firefox veranlassen, dass beim Starten alle Seiten der vorherigen Sitzung wieder geladen werden. So können Sie dort weitermachen, wo Sie aufgehört haben.
(Zusammenhang – erklärt das große Ganze, wieso wir das überhaupt machen.)

  1. Klicken Sie oben im Firefox-Fenster auf die Schaltfläche Firefox und wählen Sie Einstellungen.Klicken Sie oben im Firefox-Fenster auf das Menü Extras und wählen Sie Einstellungen.Klicken Sie in der Menüleiste auf das das Menü Firefox und wählen Sie Einstellungen....Klicken Sie oben im Firefox-Fenster auf das Menü Bearbeiten (oder auf die Schaltfläche Firefox, wenn die Menüleiste ausgeblendet ist) und wählen Sie Einstellungen....

    Einstellungen - Fx20 - Win7


    EinstellungenFx4Win7.png


    Einstellungen - Fx20 - WinXP


    Einstellungen_Fx4_Linux


    010897fd58f6e294a60e43bbcf0ffe51-1281982768-69-1.png

    Klicken Sie auf die Menüschaltfläche New Fx Menu und wählen Sie Einstellungen.

    Einstellungen öffnen - Fx29 - Win7



    Einstellungen öffnen - Fx29 - Win8



    Einstellungen öffnen - Fx29 - Linux

  2. Gehen Sie zum Abschnitt Allgemein.
  3. Klicken Sie im Start-Bereich in die Auswahlliste neben Wenn Firefox gestartet wird: und wählen Sie, was Firefox beim Starten anzeigen soll.
    • Startseite anzeigen - Zeigt die Startseite (oder mehrere Startseiten) an.
    • Leere Seite anzeigen - Zeigt eine leere Seite an, was beim Starten Zeit erspart.
    • Fenster und Tabs der letzten Sitzung anzeigen - Stellt die Seiten wieder her, die Sie beim letzten Beenden von Firefox geöffnet hatten. Weitere Informationen dazu erhalten Sie im Artikel Sitzungswiederherstellung.
  4. Klicken Sie auf OK, um das Einstellungen-Fenster zu schließenKlicken Sie auf Schließen, um das Einstellungen-Fenster zu schließenSchließen Sie das Einstellungen-Fenster .

Probieren Sie es: Legen Sie eine Gruppe von Webseiten als Ihre Startseite fest und stellen Sie Firefox so ein, dass alle Seiten geöffnet werden, die Sie beim letzten Beenden von Firefox geöffnet hatten. Dadurch können Sie schnell dort weiterarbeiten, wo Sie aufgehört haben, und haben gleichzeitig einen schnellen Zugriff auf Ihre Lieblingsseiten.
(Aktivität – gibt dem Leser eine Aufgabe und beschreibt das zu erwartende Ergebnis.)

SUMO-Stilanleitung

Wie bereits weiter oben gesagt, sollst du beim Schreiben einen aktiven Konversationsstil verwenden. Vermeide Dinge wie "Wenn die Lesezeichen des Benutzers verloren gehen ..." und sage stattdessen "Wenn Sie Ihre Lesezeichen verloren haben ...".

Hier nun einige andere, wichtige Stilvorgaben, die du für das Schreiben von Hilfeartikeln brauchen kannst:

Verwende Begriffe nur so, wie sie in der Benutzeroberfläche von Firefox zu finden sind. Beispiel:

  • Plugins hat keinen Bindestrich.
  • Add-ons hat einen Bindestrich.
  • Englische Begriffe wie Home page bestehen aus 2 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 hingegeben 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.
  • Für das erstmalige Hinterlassen seiner Anmeldedaten verwenden wir registrieren statt anmelden.
  • Sage im Englischen email statt e-mail. Im Deutschen heißt es hingegen richtig 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:


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ählungs- 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


Überschriften und Abschnitte
Unser Wiki verwendet HTML5-Elemente wie SECTION (in HTML als <section> geschrieben). Du kannst das SECTION-Element um zusammenhängenden Inhalt herum setzen. Für Überschriften bedeutet das, dass jede SECTION seine eigene Gliederung beginnend mit dem H1-Element haben kann.


Um es deutlich zu sagen: Vermeide in Sätzen die Verwendung von z.B. (engl. i.e. oder e.g.).
Wenn du es wirklich einbauen musst, mache es wie in dieser engl. Erklärung.


Für eine Reihe verschiedener Wiki-Auszeichnungen haben wir eine besondere grafische Darstellung (eine vollständige Liste findest du in der Syntaxübersicht).

  • Hinweis
  • Warnung
  • Quelltext
  • Dateinamen und Datei/pfade
  • Tastenkürzel wie Strg + T
  • Menüpfade – Firefox
  • Schaltflächen


Eine ganz besondere Wiki-Auszeichnung – {for} – erlaubt uns, bestimmte Informationen nur für bestimmte Firefox-Versionen und Betriebssysteme sichtbar zu machen.
Beispielsweise kann ein Abschnitt nur Leuten, die Windows verwenden, sichtbar gemacht werden, und ein anderer für Mac OS X-Nutzer. (Nähere Informationen darüber findest du im For-Artikel.)

War der Artikel hilfreich? Bitte warten…

Diese netten Menschen haben geholfen, diesen Artikel zu schreiben: ThomasLendo. Auch Sie können helfen – erfahren Sie, wie.