Discourse-Benutzeroberflächen und Dokumentationen werden derzeit überprüft und bearbeitet, um sie an diese Richtlinien anzupassen. Wir arbeiten so schnell wie möglich an einer vollständigen Angleichung.
Beachten Sie beim Schreiben für Discourse die folgenden Richtlinien für die Textformatierung. Diese Richtlinien gelten für Text in allen Bereichen, insbesondere für Dokumentationen und die Discourse-Benutzeroberfläche.
Großschreibung
Beim Schreiben von Dokumentationen oder Benutzeroberflächentexten sollten Sie standardmäßig die Satzschreibung verwenden (d. h. der erste Buchstabe des Satzes wird großgeschrieben und sonst nichts).
Wichtige Hinweise:
- Überschriften, Titel und Kategorienamen verwenden die Satzschreibung.
- Namen von Discourse-Funktionen werden nicht großgeschrieben, mit einzigen Ausnahmen:
Verwenden Sie keine andere Formatierung für Funktionsnamen, einschließlich keiner Fettdruck-, Kursivschrift-, Backticks-, Anführungszeichen oder etwas anderem.
Ausnahmen von der Großschreibung sind:
- Akronyme müssen immer entsprechend großgeschrieben werden.
- Produkt- und Markennamen müssen gemäß ihren Markenrichtlinien großgeschrieben werden.
- Plugin- und Themennamen müssen entsprechend großgeschrieben werden.
- Wenn Sie sich auf Menüpunkte, Schaltflächenbeschriftungen oder Formularoptionen beziehen, schreiben Sie den ersten Buchstaben des ersten Wortes groß – z. B. „Klicken Sie auf die Schaltfläche Neuer Beitrag, um mit dem Schreiben zu beginnen.“
- Wenn etwas in der Benutzeroberfläche aus einem guten Grund großgeschrieben wird, verwenden Sie dieselbe Großschreibung, wenn Sie darüber dokumentieren.
- Kategorien- und URL-Slugs sind immer kleingeschrieben.
Im Zweifelsfall verwenden Sie die Satzschreibung.
Punkte
Verwenden Sie keinen Punkt für Folgendes:
- Tooltips, Bildunterschriften oder andere Benutzeroberflächenelemente mit nur einem Satz
- Schaltflächenbeschriftungen
- Menüpunkte
- Listenelemente ohne Verb
Verwenden Sie einen Punkt für Folgendes:
- Normale Sätze
- Tooltips, Bildunterschriften oder andere Benutzeroberflächenelemente mit mehr als einem Satz
- Listenelemente mit Verb
- Bild-
alt-Text
Vorbehalt für Listenelemente: Wenn Sie eine Liste mit gemischten Elementen schreiben (d. h. einige erfordern einen Punkt und andere nicht), verwenden Sie für alle Punkte.
Hervorhebung
Um Wörter hervorzuheben, verwenden Sie standardmäßig Kursivschrift. Sie können auch Fettdruck verwenden, wenn Sie der Meinung sind, dass dies zum Kontext passt.
Backticks
Verwenden Sie Backticks (``) für Inline-Code, Beispiel-URLs und Einstellungsnamen. Verwenden Sie sie nicht für andere Zwecke.
Codeblöcke
Wenn Sie Codeblöcke einfügen, geben Sie nach Möglichkeit die Programmiersprache an, indem Sie sie unmittelbar nach dem öffnenden Zaun (den anfänglichen drei Backticks) hinzufügen – z. B. ```css.
