Hinweise für Autoren

Einige Regeln, an die wir uns halten sollten, damit ein einheitlicher Auftritt entstehen kann

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)

Link auf BYOD-iOS-Readme
Link auf BYOD-iOs-teams

Hinweis

Aus den README.md werden dann index.html und aus allen anderen md-Dateien einge 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»

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»)

Achtung

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

Benutzer ansprechen

  • Aufgaben werden mit «du» formuliert. Im Satzinnern wird «du» klein geschrieben.
  • Anleitungen mit «man» oder «du»
repo
Letzte Änderungen: