handbuch:konventionen
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
handbuch:konventionen [d.m.Y H:i] – angelegt willuhn | handbuch:konventionen [d.m.Y H:i] (aktuell) – Tippfehler korrigiert (garbig .. farbig) marmar | ||
---|---|---|---|
Zeile 11: | Zeile 11: | ||
- Für Gliederungen innerhalb des Kapitels können H4-Überschriften genutzt werden. | - Für Gliederungen innerhalb des Kapitels können H4-Überschriften genutzt werden. | ||
* Falls im Text Bezeichner aus Hibiscus verwendet werden (also z.Bsp. die Beschriftungen von Buttons oder Namen von Dialogen), sollten diese in Anführungszeichen gesetzt werden, um zu verdeutlichen, | * Falls im Text Bezeichner aus Hibiscus verwendet werden (also z.Bsp. die Beschriftungen von Buttons oder Namen von Dialogen), sollten diese in Anführungszeichen gesetzt werden, um zu verdeutlichen, | ||
- | * Klickpfade sollten durch das Zeichen " | + | * Klickpfade sollten durch -> (Bindestrich, |
- | * Besondere Hinweise sollten mit dem Pipe-Symbol " | + | * Besondere Hinweise sollten mit dem Pipe-Symbol " |
* Kommandozeilen-Befehle sollten mit zwei Leerzeichen eingerückt werden. Die Wiki-Formatierung interpretiert das als Code-Fragment und verwendet eine nichtproportionale (dicktengleiche) Schrift wie Courier. Die Formatierung verdeutlicht, | * Kommandozeilen-Befehle sollten mit zwei Leerzeichen eingerückt werden. Die Wiki-Formatierung interpretiert das als Code-Fragment und verwendet eine nichtproportionale (dicktengleiche) Schrift wie Courier. Die Formatierung verdeutlicht, | ||
* Soll in einem Satz ein Wort besonders hervorgehoben werden. kann es fett-gedruckt werden. Beispiel: Beachten Sie, dass die Datei hierbei **gelöscht** wird. | * Soll in einem Satz ein Wort besonders hervorgehoben werden. kann es fett-gedruckt werden. Beispiel: Beachten Sie, dass die Datei hierbei **gelöscht** wird. | ||
Zeile 21: | Zeile 21: | ||
* Der Text sollte in ganzen Sätzen formuliert sein, nicht in Stichpunkten. | * Der Text sollte in ganzen Sätzen formuliert sein, nicht in Stichpunkten. | ||
- | * Der Leser sollte | + | * Der Leser sollte |
+ | * Der Leser kann mit "Du" angesprochen werden. Beispiel: | ||
* Der Leser sollte Aktionen nach Möglichkeit nicht " | * Der Leser sollte Aktionen nach Möglichkeit nicht " | ||
+ | * Ausrufezeichen sollten generell vermieden werden. | ||
Impressum | Datenschutz
handbuch/konventionen.txt · Zuletzt geändert: d.m.Y H:i von marmar