Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- 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.
   * 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, dass in Hibiscus genau dieser Begriff verwendet wird. Beispiel: Klicken Sie auf den Button "Zurück".
-  * Klickpfade sollten durch das Zeichen " > " dargestellt werden. Beispiel: Klicken Sie im Menü auf "Plugins > Hibiscus > Einstellungen".
+  * Klickpfade sollten durch -> (Bindestrich, gefolgt von spitzer Klammer nach rechts) dargestellt werden. Beispiel: Klicken Sie im Menü auf "Hibiscus -> Einstellungen".
-  * Besondere Hinweise sollten mit dem Pipe-Symbol "|" umschlossen werden. Die Wiki-Formatierung erstellt daraufhin eine einspaltige Tabelle für den Absatz und hebt ihn somit garbig und mittels Umrandung hervor. Die Schriftart für Fließtext bleibt jedoch erhalten.
+  * Besondere Hinweise sollten mit dem Pipe-Symbol "|" umschlossen werden. Die Wiki-Formatierung erstellt daraufhin eine einspaltige Tabelle für den Absatz und hebt ihn somit farbig und mittels Umrandung hervor. Die Schriftart für Fließtext bleibt jedoch erhalten.
   * 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, dass es sich um einen Befehl handelt.
   * 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 Leser sollte mit "Sie" und nicht mit "Du" angesprochen werden. Beispiel: "Klicken Sie auf ...." statt "Klicke auf ..."
+  * Der Leser sollte persönlich angesprochen werden. An ihn wendet sich das Handbuch. Also weder sächliche Schreibweise in der Form "es wird Schaltfläche ... geklickt" oder "wir klicken auf Schaltfläche ..." sondern "Klicken Sie auf Schaltfläche ...".
+  * Der Leser kann mit "Du" angesprochen werden. Beispiel: "Klicke auf ..." (in einer vorherigen Version dieser Handbuch-Konventionen wurde noch das "Sie" vorgegeben).
   * Der Leser sollte Aktionen nach Möglichkeit nicht "müssen" sondern "können". Beispiel: "Klicken Sie auf ... um das Fenster zu schließen." oder "Sie können das Fenster durch Klick auf ... schließen" statt "Zum Schließen des Fensters müssen Sie auf ... klicken.". Es soll dem Leser überlassen bleiben, ob er das tatsächlich möchte.
+  * Ausrufezeichen sollten generell vermieden werden.

Impressum | Datenschutz