Zum Hauptinhalt springen

Hinweise für Autoren

Typografie

Immer auf md-Datei verlinken, ausser Links auf README.md: dort auf Ordner verlinken:

[Link auf BYOD-iOS-Readme](../byod/ios/)

[Link auf BYOD-iOs-teams](./components)

Tipp

Aus den README.md werden dann index.html und aus allen anderen md-Dateien eine gleich benannte html-Datei

Text hervorheben

  • Fremd- und Sachwörter kursiv
  • sonst gewichten mit fett

GUI-Elemente

  • Hinweis: im Tab Einstellungen
  • Bedienung: Wähle den Menüpunkt Datei Öffnen
  • Bedienung: Klicke auf Akzeptieren.
* Fremd- und Sachwörter *kursiv*
* sonst gewichten mit **fett**
* GUI-Elemente: im Tab _Einstellungen_
* Menüpunkte und Knöpfe: Klicke auf __Akzeptieren__.

Anführungszeichen

Wir verwenden «Guillemets»

OSX

OsX «
Option + ,
»
Shift + Option + ,

Bindestrich oder Trennstrich?

Wir unterscheiden zwischen diesen beiden:

  • Gedankenstrich (em-Dash): –
  • Bindestrich (Minus): -

Dateitypen Dateiendungen

(Quelle: Wikipedia macht das so)

Wir schreiben Dateitypen in Grossbuchstaben:

SVG-Dateien können mit Inkscape bearbeitet werden.

Wir schreiben Dateieindungen mit vorangestelltem Punkt in Kleinbuchstaben als Code:

Adobe Photoshop-Dateien mit der Dateiendung .psd.


Sprache

Begriffe

  • Wenn möglich deutsche Begriffe verwenden (z.B. Benutzer statt User)
  • Begriffe einheitlich verwenden (Sachbegriffe gleich verwenden, nicht mal «Rechnernetz» dann «Netzwerk» und dann «LAN»)
Vorsicht

Schreiben wir Dateiendung oder Dateierweiterung?

Wikipedia
Dateinamenserweiterung
Windows
Erweiterungen (z.B. «Erweiterungen bei bekannten Dateitypen ausblenden»)
Google sagt
Dateiendung: 800'000
Dateierweiterung: 125'000
Dateinamenserweiterung: 45'000

Wir sprechen von Dateiendungen

Benutzer ansprechen

  • Aufgaben werden mit «du» formuliert. Im Satzinnern wird «du» klein geschrieben.
  • Anleitungen mit «man» oder «du»