Compare Revisions

Diese Anleitung zum Schreiben von Mozilla-Hilfe-Artikeln beinhaltet die Auswahl eines guten Titels, das Verfassen einer Suchzusammenfassung, die Gliederung Ihres Artikels und einen Stil-Leitfaden.

Als Mitwirkender an der 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 unserer Ausdrucksweise begeistern. Wie stellen Sie das an? Hier sind einige Dinge, die wir bei unserer Recherche herausgefunden haben. {note}'''Wir freuen uns über Vorschläge!''' Wenn Sie zusätzliche Vorschläge haben, posten Sie diese bitte im [/en-US/kb/writing-guide-knowledge-base-articles/discuss Diskussionsforum dieses Artikels].{/note} __TOC__ ==Tonfall== Schreiben Sie mit der Marke im Hinterkopf. 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 Mitwirkenden aus der ganzen Welt, die gemeinsame Werte teilen. Sie müssen diese Geschichte nicht jedes Mal wiederholen, wenn Sie einen Artikel schreiben. 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 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. Nehmen Sie an, dass die Person, für die Sie schreiben, nicht weiß, wie sie Einstellungen ändern oder eine Schaltfläche zur 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. Zusammenfassend sollten Sie diese Richtlinien befolgen: #'''Fassen Sie sich kurz.''' Die Nutzer kommen in die Wissensdatenbank auf der Suche nach schnellen Lösungen. Die inneren Abläufe des Tools sind ihnen vielleicht egal – sie wollen nur wissen, was '''sie''' tun sollen, um es zu reparieren. Streichen Sie ruhig ein paar Wörter. Sehen Sie, wie viel Sie mit weniger Worten vermitteln können. Das ist wie Poesie! #'''Seien Sie klar und 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. #'''Seien Sie freundlich, humorvoll und einfühlsam. (Kurz gesagt: Seien Sie menschlich.)''' Okay, Nutzer erwarten bei einer Hilfeseite keinen Spaß. Das macht es so wirkungsvoll. Erheitern Sie den Tag des Nutzers mit ein wenig Humor. Achten Sie aber darauf, die Verständlichkeit nicht durch lustige Metaphern oder Ausdrücke zu beeinträchtigen. Wenn Sie nicht sicher sind, wie Sie die Balance halten sollen, schreiben Sie einfach klare Anweisungen und verwenden Sie den entsprechenden Tonfall in der Einleitung oder im Fazit. #'''Erzählen Sie eine Geschichte.''' Sorgen Sie für einen Anfang, eine Mitte 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. #*'''Mitte:''' Hier stehen die Anweisungen. Dieser Teil 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 mehr erfahren möchte. Lesen Sie den nächsten Abschnitt für umfassendere Richtlinien. ==Schreibstil (umfassend)== *'''Gesprächsstil''' – Verwenden Sie 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. Emotionen wie „Überraschung” und „Das wusste ich nicht/Heureka!“ 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 Sie etwas mit verschiedenen Mitteln auf unterschiedlichem Wege erklären, wiederholen Sie sich (offensichtlich). Das ist eine gute Möglichkeit, den Lesern dabei zu helfen, sich an die wichtigen Dinge zu erinnern. *'''Grafiken und Videos''' – Die Verwendung von Grafiken und Videos zur Unterstützung des Textes ist nicht nur die nächstbeste Alternative zur persönlichen Hilfe, sondern auch eine einfache Möglichkeit, verschiedene 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. Bei einem Schritt, bei dem eine Schaltfläche angeklickt wird, könnten Sie beispielsweise „Klicken Sie auf {button OK}“ schreiben, anstatt einen Screenshot des Dialogfelds dieser Schaltfläche hinzuzufügen. *'''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. ==Artikeltypen== Die Verwendung einheitlicher 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, die jeweils einem bestimmten Zweck dienen: *'''Grundlagen''': Diese Artikel beantworten Fragen wie „Was ist…?“ und liefern wesentliche Informationen, um den Lesern das Verständnis eines Themas zu erleichtern. *'''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 Verfahren zu erreichen. *'''Fehlerbehebung''': Diese Artikel unterstützen Nutzer 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 effektiven und aussagekräftigen 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 auf sich ziehen, 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 anzuzeigen, was Nutzer tun können, um ein Problem zu lösen oder ein Ziel zu erreichen. Vermeiden Sie die Verwendung von 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 hier richtig ist. *'''Für einen „Grundlagen“-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. Bedenken Sie, dass sich eine gute Einleitung normalerweise zugleich als Zusammenfassung für die Suchfunktion eignet. Oft können Sie sie einfach unverändert in das Feld „Zusammenfassung für Suchergebnisse“ kopieren und sind fertig. ==Artikel effektiv aufbauen== Grundsätzlich sollen die im Artikel gelernten oder geforderten Fähigkeiten ansteigen. Beginnen Sie mit den einfachen und beenden Sie 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. ==Schritt-für-Schritt-Anleitungen leicht verständlich gestalten== Bei Schritt-für-Schritt-Anleitungen müssen Sie 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 {button 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 Sie beachten sollten: *Es gibt immer mehrere Wege, um ans Ziel zu gelangen. Wählen Sie – soweit möglich – immer den benutzerfreundlichsten Weg, z. B. über die [https://de.wikipedia.org/wiki/Grafische_Benutzeroberfl%C3%A4che grafische Benutzeroberfläche] und die Menüs. *Verwenden Sie vollständige Sätze, wenn Sie den Zugriff auf die Benutzeroberfläche beschreiben. *Bauen Sie erwartete Resultate ein, wenn Sie eine Anleitung schreiben (z. B.: ''Klicken Sie auf „OK“ und das Fenster wird sich schließen.''). ==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. * Große Textabsätze vermeiden. Es gibt keine Begrenzung für die Textmenge. Je mehr Material, desto besser; Sie sollten es jedoch nicht künstlich erweitern. Stellen Sie nur nützliche, wertvolle und notwendige Informationen bereit. ==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 direkte Aufnahme von Schritten für diese Software in unsere Artikel kann jedoch zu Herausforderungen führen: *'''Schnell veraltete Informationen:''' Updates von Drittanbieter-Software können unsere Anleitungen überflüssig machen und unsere Nutzer potenziell verwirren oder irreführen. *'''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:''' Wann immer Anweisungen 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 verweisen (z. B.: „Für die neuesten und genauesten Schritte zur Anpassung Ihrer Systemeinstellungen lesen Sie bitte die offizielle Support-Seite von <nowiki>[Softwarename]</nowiki>“). *'''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 (z. B. „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: <blockquote> „''Für die neuesten Schritte zur Anpassung Ihrer Systemeinstellungen unter macOS konsultieren Sie bitte die offizielle Apple-Support-Dokumentation, indem Sie [https://support.apple.com/de-de/guide/mac-help/mh15217/mac dieser Anleitung] folgen. Bitte beachten Sie, dass Sie durch Folgen dieses Links auf eine externe Website weitergeleitet werden, die nicht von Mozilla betrieben wird.''“ </blockquote> Dies stellt sicher, dass Sie den aktuellsten Anweisungen direkt von der Quelle folgen. ==Technische Richtlinien== * Wie Sie einen neuen Artikel erstellen, erfahren Sie unter [[Create a new Knowledge Base article]]. * Wie Sie einen bestehenden Artikel bearbeiten, erfahren Sie unter [[Edit a Knowledge Base article]]. * Einen Überblick über die Funktionsweise der Wissensdatenbank finden Sie unter [[About the Knowledge Base]]. * Eine vollständige Liste der Artikel-Dokumentation finden Sie unter [[Improve the Knowledge Base]]. ==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: Dieser Punkt betrifft hauptsächlich englischsprachige Artikel. Im Deutschen werden Substantive ohnehin großgeschrieben. In englischen Titeln sollte das erste Wort großgeschrieben werden, ebenso wie [https://de.wikipedia.org/wiki/Eigenname Eigennamen] und Namen, aber nicht jedes wichtige Wort. Verwenden Sie den [https://reviewediting.wordpress.com/2012/07/10/titles-sentence-style-or-headline-style/ „Satz“-Stil, nicht den „Überschriften“-Stil] (dasselbe gilt für Überschriften). Weitere Regeln zur Großschreibung finden Sie im Abschnitt [[#w_stilanleitung-und-textregeln|Stilanleitung und Textregeln]] weiter unten. * Verwenden Sie keinen Doppelpunkt im Artikeltitel, da dies die Erstellung eines Wiki-Links zu diesem Artikel verhindert ([https://bugzilla.mozilla.org/show_bug.cgi?id=749835 bug 749835]). Stellen Sie auch sicher, dass Sie keine zusätzlichen Leerzeichen im Artikeltitel haben, da dies ebenfalls die Funktion von Wiki-Links verhindert. * Versuchen Sie, die Benennung von Artikeln zu variieren. Verwenden Sie nicht in jedem Titel dieselben Wörter oder Phrasen. Beginnen Sie Artikel beispielsweise nicht immer mit „Wie“ und vermeiden Sie Aufgabennamen mit „-ing“ wie „Setting the home page“. * 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 (URL-Endung)== Wenn Sie einen neuen Artikel erstellen und einen Titel eingeben, erstellt SUMO automatisch einen ''Slug'' (den Teil nach <code>kb/</code> am Ende der [https://de.wikipedia.org/wiki/Uniform_Resource_Locator 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ängenbegrenzung 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. ===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, behalten Sie den aktuellen Slug bei, es sei denn, der neue Titel stellt eine so wesentliche Änderung dar, dass er nicht mehr zum bestehenden Slug passt. Die Beibehaltung des Slugs hilft, fehlerhafte Links zu vermeiden und den SEO-Wert zu erhalten. ==Kategorien, Produkte und Themen== Größtenteils gehört ein Artikel entweder in die Kategorie ''Anleitung'' oder ''Fehlerbehebung''. Gelegentlich schreiben wir Artikel in einer der anderen Kategorien, wie z. B. „Wie Sie mithelfen können“-Artikel (wie dieser hier). Die Versionsgeschichte 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“. {note}'''Hinweis:''' Bitte beachten Sie, dass die Kategorie ''Administration'' Artikel vor öffentlichen Suchen verbirgt, aber den Zugriff per URL weiterhin gewährt. 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 jederzeit in eine andere Kategorie verschoben werden, indem die Artikel-Metadaten bearbeitet werden, wie [[Edit a Knowledge Base article#w_edit-description-reviewers-only|hier]] erklärt. {/note} ==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 erhalten Sie im Artikel [[When and how to use keywords to improve an article's search ranking]]. ==Schreiben Sie eine gute Zusammenfassung für Suchergebnisse== Die Zusammenfassung eines Artikels hilft den Nutzern zusammen mit dem Titel zu beurteilen, ob ein Artikel ihre Frage beantworten wird. Wir nennen das „Nutzervertrauen“ und es beeinflusst direkt die Klickraten. 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. Zusätzlich sollte eine Zusammenfassung diese Richtlinien befolgen: * Kurz und auf den Punkt. Erinnern Sie sich an Kleinanzeigen? Schreiben Sie es so. Suchmaschinen können alles abschneiden, was länger als 140 Zeichen ist. Wenn Sie eine längere Zusammenfassung verwenden, stellen Sie die wichtigen Informationen an den Anfang. '''''Hinweis:''''' Die KB-Software zeigt 20 verbleibende Zeichen an, wenn die Zusammenfassung 140 Zeichen erreicht, da die interne Suchbegrenzung 160 beträgt. * Verwenden Sie keine Wiki-Syntax. * Verwenden Sie nicht in jeder Zusammenfassung „Dieser Artikel erklärt“. Variieren Sie, wenn möglich. Einige andere Formulierungen, 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, die Gesamtzahl der Schritte im Bereich von sechs bis sieben zu halten. ==Parallele Struktur== Verwenden Sie für jeden Schritt, den Sie schreiben, dieselbe Formulierung oder dasselbe Wortmuster. Eine parallele Struktur ist in KB-Artikeln wichtig, weil sie die Dinge klar und leicht verständlich macht. Wenn ähnliche Elemente ein einheitliches 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: # Suchen Sie '''Chronik löschen, wenn Firefox geschlossen wird'''. Wenn diese Option ausgewählt ist: ## Klicken Sie auf die Schaltfläche {button Einstellungen…}. ## Stellen Sie sicher, dass '''Formular- & Suchchronik''' '''nicht''' ausgewählt ist. ## Klicken Sie auf {button 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 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 „Unterhalb 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. Anstatt zum Beispiel zu sagen ''Klicken Sie auf die Schaltfläche'', verwenden Sie ''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. =Stilanleitung und Textregeln= Wie bereits erwähnt, sollten Sie beim Schreiben einen aktiven, gesprächsähnlichen Stil verwenden. Vermeiden Sie Formulierungen wie „Wenn die Lesezeichen eines Benutzers 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. *Startseite ist ein Wort (im Gegensatz zum englischen „Home page“). '''Allgemeine Computerbegriffe:''' *[https://de.wikipedia.org/wiki/Website Website] ist ein Wort. [https://de.wikipedia.org/wiki/Webseite Webseite] ist ein Wort. *Anmelden und abmelden sind Verben. Beispiel: „Melden Sie sich auf der Website an.“ Dasselbe gilt für „sign in“ und „sign out“ im Englischen. Verwenden Sie nicht „log into“ oder „sign into“.<!-- https://design.firefox.com/photon/copy/word-list.html#s --> *Login und Logout sind Substantive (meist als Adjektive verwendet). Beispiel: „Klicken Sie auf die Login-Schaltfläche.“ *Verwenden Sie E-Mail anstelle von Email. *Der Plural von CD-ROM ist CD-ROMs. '''Links zu mozilla.org sollten keine Sprachkennung enthalten:''' *Verwenden Sie https://www.mozilla.org/ anstelle von https://www.mozilla.org/de/ '''Beim Einbinden von Links in Sätze:''' *Vermeiden Sie die Verwendung von „klicken Sie hier“ 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ß:''' *[https://de.wikipedia.org/wiki/Eigenname 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 werden normalerweise kleingeschrieben *Das erste Wort in nummerierten Listen 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 '''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 „anmelden“ und „abmelden“. *Verwenden Sie in Verbform „sich bei Ihrem Konto anmelden“ (nicht „sich in Ihr Konto anmelden“), um grammatikalisch korrekt zu sein. *Sie können auch „Mit Mozilla anmelden“ verwenden. *„Anmelden“ sollte immer als Verb verwendet werden. Wenn Sie es als Substantiv verwenden, benutzen Sie „Login“. *Verwenden Sie „registrieren“ als Handlungsaufforderung zur Erstellung eines neuen Kontos. Details zur Bezugnahme auf Mozilla accounts in KB-Artikeln finden Sie unter [[Editorial guidelines for Mozilla accounts]]. '''Verwenden Sie nicht [https://theoatmeal.com/comics/ie „i.e.“ und „e.g.“]'''. Diese lateinischen Abkürzungen können Menschen verwirren. Verwenden Sie aus Gründen der Klarheit „mit anderen Worten“ oder „anders ausgedrückt“ anstelle von i.e., wenn Sie etwas auf 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 [https://de.wikipedia.org/wiki/Oxford-Komma Oxford-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, Fehlercodes, Tasten und Schaltflächen erscheinen, 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(/) aus''' bei Pfaden und Suchen, um Verwechslungen zu vermeiden. Beispiel: „Einige Pfadnamen zu Bildern enthalten Backslashes (\\)“. '''Tastenkombinationen''' Schreiben Sie den ersten Buchstaben einer Tastenkombination oder einer Kombination von Kürzeln groß: {key Strg+Umschalt+C} oder {key Befehl+Umschalt+C}. '''Verwenden Sie keine [https://courses.lumenlearning.com/englishforbusiness/chapter/4-8-slang-and-idioms/ 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 der richtigen Wiki-Syntax um das Element herum erreicht werden können.''' Sehen Sie sich die [[Markup chart|Syntaxübersicht]] für die gebräuchlichsten Stile an. '''Wir haben eine spezielle Wiki-Syntax – <nowiki>{</nowiki>for<nowiki>}</nowiki> – die es Ihnen ermöglicht, Informationen für bestimmte Versionen von Firefox oder bestimmte Betriebssysteme gezielt anzuzeigen.''' Zum Beispiel zeigen Sie eine Reihe von Anweisungen für Personen an, die Windows verwenden, und eine andere für Personen, die macOS X verwenden (siehe [[How to use "For" tags|Verwendung der „For“-Syntax]] für Details).