Beim Schreiben oder Bearbeiten eines Artikels müssen viele konkurrierende Aspekte gegeneinander abgewogen werden. Der Artikel soll gleichzeitig vollständig und prägnant, sachlich und ansprechend sein. Das ist sicherlich nicht die einfachste Aufgabe der Welt. Hier sind einige Richtlinien, die Ihnen helfen, diesen Balanceakt ein wenig zu erleichtern. Außerdem ist dies ein Wiki und wir können jederzeit etwas überarbeiten, wenn wir einen Fehler gemacht haben.
Inhaltsverzeichnis
Für wen schreiben wir Artikel?
Wir möchten, dass die Thunderbird-Hilfe für alle Thunderbird-Nutzer verständlich und nutzbar ist. Das bedeutet, wir schreiben für ein allgemeines Publikum und nicht für Personen, die mit Computertechniken und -terminologie sehr vertraut sind. 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. Wir sollten auch davon ausgehen, dass die Nutzer keine der Standardeinstellungen von Thunderbird oder des Betriebssystems geändert haben.
Einen guten Titel wählen
Bei der Wahl eines Artikeltitels sollten wir versuchen, das zu treffen, wonach die Leute suchen und stöbern – also die Frage zu beantworten, die sie Ihnen persönlich stellen könnten. Hier sind einige Beispiele für Titel, die Sie wählen sollten:
- Für eine Anleitung oder einen „Wie geht das“-Artikel: Wie erreiche ich dieses Ergebnis? (z. B. Wie sende ich eine E-Mail?)
- Für einen Referenzartikel: Was ist/sind [Funktionsname]? (z. B. Was sind Plug-ins?)
- Für einen Artikel zur Fehlerbehebung: Das ist das Problem, das ich habe (z. B. Thunderbird braucht lange zum Starten)
Techniken für einen ansprechenden Schreibstil
Die Thunderbird-Hilfe ist eine Sammlung technischer Informationen über die Funktionsweise des E-Mail-Programms Thunderbird. Die Dokumentation listet die Funktionen der verschiedenen Merkmale von Thunderbird, Verfahren zur Fehlerbehebung und Anleitungen zur Lösung häufiger Probleme auf. Die Dokumentation kann über die Suchfunktion auf jeder Seite aufgerufen werden.
Verwenden Sie die folgenden Techniken und Richtlinien, wenn Sie Hilfeartikel schreiben. Diese Richtlinien helfen den Nutzern zu lernen, wie sie die Software verwenden oder ein bestimmtes Problem lösen können.
- Konversationeller Schreibstil – Verwenden Sie einen informellen, aktiven Stil, ähnlich wie Sie mit jemandem persönlich sprechen würden.
- Humor und Emotionen – Halten Sie Humor und Emotionen auf ein Minimum beschränkt. Wenn es angebracht ist, verwenden Sie in Artikeln ermutigende oder hilfreiche Tipps und Ratschläge, um dem Nutzer bei der Erledigung der Aufgabe zu helfen. Die Verwendung von Humor oder anderen Emotionen hilft dem Nutzer nicht und kann ihn oder sie sogar frustrieren.
- Unterschiedliche Lernstile – Genau wie in der Schule lernen Menschen auf unterschiedliche Weise. Außerdem profitiert jeder davon, wenn derselbe Inhalt auf verschiedene Weisen ausgedrückt wird.
- Wiederholung – Wenn Sie Konzepte oder Aufgaben auf verschiedene Weisen erklären, wiederholen Sie sie nicht nur, sondern helfen dem Nutzer auch, die Kernideen zu behalten.
- Bilder und Videos – Die Verwendung von Bildern und Videos zur Erklärung von Sachverhalten neben dem Text ist nicht nur die nächstbeste Sache, um persönlich zu helfen, sondern auch eine einfache Möglichkeit, verschiedene Lernstile und Wiederholungen einzubeziehen.
- Aktivitäten – Besonders in einer Anleitung 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, Dinge auszuprobieren.
Der Artikel Thunderbird-Passwörter durch ein Hauptpasswort schützen ist ein gutes Beispiel für einen Artikel, der diese Techniken anwendet.
Eine gute Einleitung schreiben
Neben dem Titel und dem Inhaltsverzeichnis ist die Einleitung das, was die Leute verwenden, um schnell festzustellen, ob sie am richtigen Ort sind.
- Für eine Anleitung oder einen „Wie geht das“-Artikel: Geben Sie eine kurze Zusammenfassung dessen, was gelernt werden kann.
- Für einen Referenzartikel: Geben Sie eine kurze Erklärung der Funktion.
- Für einen Artikel zur Fehlerbehebung: Geben Sie eine kurze Zusammenfassung des Problems und seiner Symptome.
Eine gute Einleitung kann in der Regel als gute Zusammenfassung für die Suche dienen. Oft können Sie sie einfach in das Feld „Zusammenfassung für Suchergebnisse“ kopieren und sind fertig.
Den Artikel organisieren
Die allgemeine Idee hier ist, zu versuchen, Fähigkeiten von einfach bis komplex aufzubauen, während man versucht, die von den meisten Leuten benötigten Informationen weit oben zu halten. Eine einfache, gängige Lösung sollte also in der Regel vor einer komplexen oder einer Lösung für einen Sonderfall stehen.
Schritt-für-Schritt-Anleitungen leicht verständlich machen
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, d. h. nach Möglichkeit die grafische Benutzeroberfläche und die Menüs verwenden.
- Verwenden Sie ganze Sätze, wenn Sie beschreiben, wie auf die Benutzeroberfläche zugegriffen wird.
- Geben Sie bei Anweisungen die erwarteten Ergebnisse an (z. B. Klicken Sie auf OK und das Fenster wird geschlossen).
Hier ist ein Beispiel aus dem Artikel Thunderbird-Passwörter durch ein Hauptpasswort schützen mit einigen Erklärungen in Klammern.
Das Master-Passwort ändern oder entfernen
(Die Überschrift – was die Schritte bewirken werden)
Sie können Ihr Master-Passwort jederzeit ändern oder entfernen:
(Kontext – zeigt das große Ganze – warum tun wir das)
- Klicken Sie oben im Thunderbird-Fenster auf das Menü und wählen Sie .
- Klicken Sie auf das Symbol .
- Klicken Sie auf den Tab .
- Klicken Sie auf .
- Geben Sie das aktuelle Passwort ein, um zu bestätigen, dass Sie berechtigt sind, es zu ändern.
- Wenn Sie Ihr Master-Passwort vergessen haben, lesen Sie den Artikel Zurücksetzen Ihres Hauptpassworts, falls Sie es vergessen haben.
- Geben Sie das neue Master-Passwort zweimal ein.
- Um das Master-Passwort zu entfernen, lassen Sie die Felder für das neue Master-Passwort leer.
- Um das geänderte Master-Passwort zu übernehmen, klicken Sie auf .
- Das Master-Passwort ist geändert.
SUMO-Stilrichtlinie
Wie bereits erwähnt, sollten Sie beim Schreiben einen aktiven, konversationellen Stil verwenden. Vermeiden Sie also 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 Stilprobleme, auf die Sie beim Schreiben von Support-Artikeln stoßen können:
Verwenden Sie Begriffe immer so, wie sie in der Thunderbird-Benutzeroberfläche erscheinen. Zum Beispiel:
- Plugins wird ohne Bindestrich geschrieben.
- Add-ons wird mit Bindestrich geschrieben.
- Home page sind zwei Wörter.
Allgemeine Computerbegriffe:
- Das Internet wird kleingeschrieben.
- Website ist ein Wort.
- Log in und log out sind Verben, z. B. „Log in to the website.“
- Login und logout sind Substantive (normalerweise als Adjektive verwendet), z. B. „Click the login button.“
- Verwenden Sie email anstelle von e-mail.
- Der Plural von CD-ROM ist CD-ROMs.
Links zu den Websites sollten die Sprachkennung nicht enthalten:
- Verwenden Sie https://addons.mozilla.org/thunderbird/ anstelle von https://addons.mozilla.org/en-US/thunderbird/
Schreiben Sie die folgenden Elemente groß:
- Eigennamen
- Das erste Wort eines vollständigen Satzes
- Die Buchstaben von Abkürzungen und Akronymen, es sei denn, sie werden normalerweise kleingeschrieben
- Das erste Wort in nummerierten oder Aufzählungslisten
- 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
Überschriften und Abschnitte
Unser Wiki wird mit HTML5 angezeigt, das das Element <section> verwendet. Sie können das Element <section> um zusammengehörige Inhalte herum verwenden. Für Überschriften bedeutet dies, dass jeder Abschnitt seine eigene Gliederung haben kann, die mit einer Überschrift der Ebene h1 beginnt.
Vermeiden Sie aus Gründen der Klarheit die Verwendung von i.e. und e.g. Wenn Sie sie verwenden müssen, finden Sie hier eine nette Erklärung, wie es gemacht wird.
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 (eine vollständige Liste finden Sie in der Markup-Tabelle der Wissensdatenbank für Firefox und Thunderbird).
- Hinweis
- Warnung
Code- File names und file/paths
- Tastaturkürzel wie Ctrl + T
- Menüpfade –
Wir haben ein spezielles Wiki-Markup – {for} – mit dem Sie Informationen für bestimmte Versionen von Thunderbird oder bestimmte Betriebssysteme gezielt ausrichten können. Sie können beispielsweise einen Satz Anweisungen für Personen anzeigen, die Windows verwenden, und einen anderen für Personen, die Mac OS X verwenden (Lesen Sie für Details den Abschnitt „SHOWFOR“ in unserer Markup-Anleitung).
