Styleguide

Tipps, Tricks und einen Leitfaden, damit alle vom Gleichen reden.

Unser Grundsatz: Kurz und knackig, aber nichts verheimlichen. Users first!

Beispiele / Konfigurationen

Es war einmal eine Studentin, die hiess Maria Muster. Maria war während dem Studium den Vorlesungen fleissig und hat viele Dokumentationen mit dem Benutzernamen maria.muster, der E-Mail-Adresse maria.muster@ost.ch und Marias Passwort, GeHeim007, erstellt.

Shell

Auf ihrem Computer hat Maria ein tolles Unixoid mit dem lokalen Benutzernamen maria installiert. Eine Shell (Bash!) sieht immer folgendermassen aus:

echo "Hello World"

Maria hat nie eine Root-Shell offen - sie ruft Kommandos, welche erweiterte Rechte benötigen immer mit sudo auf!

Tastenkürzel

Um ihre Arbeit speditiv zu erledigen, benutzt Maria gerne Tastenkürzel. Tastenkürzel werden immer wie folgt dargestellt.
Ctrl + Shift + T

Kurzum

Bezeichnung Bedeutung
Name Maria Muster
OST-Benutzer maria.muster
E-Mail-Adresse maria.muster@ost.ch
Passwort GeHeim007
Shell normal $
Shell root $#
User lokal maria

Seitenhierarchie

URL Bedeutung Beispiele
/SEITE Chefseiten Startseite, Vereinsstatuten etc.
/hsr/NAME Umgebung an der OST WLAN, Drucken
/app/NAME OST-Programmkonfiguration Thunderbird, Eclipse
/tipps/NAME Tipps & Tricks aus der Community Github Student Developer Pack etc.

Dokumentationen zur Umgebung an der OST

In diese Kategorie fallen grundsätzliche, programmunabhängige technische Angaben.

Zudem wird jeweils die von uns empfohlene, einfachste Lösung mit Ubuntu von der Programmkonfiguration eingebunden.

OST-Spezifische Programm- oder Systemkonfiguration

Hier werden OST-Konfigurationen für bestimmte Programme sowie Schritt-für-Schritt Anleitungen für Einsteiger hinterlegt.

Weiteres

Falls deine Dokumentation hier nirgendwo reinpassen sollte oder du noch Fragen hast, öffne doch bitte ein GitHub-Issue, damit wir eine saubere Lösung finden.

Informationen zum Inhalt Format

Einrückung ist mit > in Markdown möglich.

Listen mit * text schreiben, es gibt momentan keine verschachtelten Listen.

  • text1
  • text2
  • text3