Cheatsheet

Ziele

• Du verstehst den Aufbau einer typischen Modulseite bei it-ninjas.
• Du kannst alle verfügbaren Shortcodes korrekt einsetzen.
• Du kennst empfohlene und veraltete Shortcodes.

Einführung

Dieses Cheatsheet zeigt dir anhand von Beispielen, wie eine Modulseite im Projekt it-ninjas aufgebaut ist. Es basiert auf dem it-ninjas Styleguide und wird laufend aktualisiert.

Info-Boxen

Verwende Ninja-Boxen, um Informationen klar hervorzuheben:

Das ist eine Info-Box für ergänzende Hinweise.

Das ist eine Tip-Box mit einem hilfreichen Hinweis.

Das ist eine Warnung – hier muss man besonders aufpassen.

Entschuldige, da fehlt noch was...

--> Hier fehlt noch etwas – markiert als TODO.

Video einbinden

Für zusätzliche Erklärungen kannst du Videos einbinden:

Lernvideo

Wenn du dir die Erklärung noch mit einem Video anschauen möchtest, empfehlen wir dir dieses Video (ninja-pinguine).

Code und Aufgaben

Codeblöcke für verschiedene Betriebssysteme

1

echo Default is visible to all OS

1

echo Hello from Windows

1

echo Hello from Linux

1

echo Visible on all OS

Links in einem neuen Fenster

Da das öffnen in einem neuen Fenster von Markdown und Hugo nicht direkt unterstützt wird kümmert sich ein Script beim starten der Seite darum. Mit einem ! am Anfang des Link-Text, wird der Link in einem neuen Fenster geöffnet.

Das wird im gleichen Fenster geöffnet.

Das wird !in einem neuen Fenster geöffnet.

Aufgabenlinks

• Einzelne Aufgabe:

  Jetzt bist du dran. Löse bitte die folgende Aufgabe in den Labs.

• Mehrere Aufgaben:

  Jetzt bist du dran. Löse bitte die folgenden Aufgaben in den Labs.

Du kannst die Klammenr auch weglassen und nur den reinen Pfad als Parameter übergeben. Das mit den Klammern hat aber den Vorteil, dass z.B. VS Code den Pfad als Link behandeln und dir in der IDE zeigen, wohin der Pfad zeigt (und so, ob er gültig ist).

Links zu Labs oder Dokumentationen

• Zu einem Lab: Zur Aufgabe

• Markdown-Link-Variante: Zur Aufgabe

• HTML-ähnlich: Zur Aufgabe

• Zur Dokumentation zurück:

  Hier kommst Du zurück zur Dokumentation.

  Hier kommst Du zurück zur Dokumentation: Java Grundlagen.

Plattformabhängige Inhalte

Zeige Inhalte nur, wenn ein bestimmtes Betriebssystem konfiguriert ist:

Formatierte Konfigurationsdateien (z. B. pom.xml)

Verwende diesen Shortcode, damit der XML-Code korrekt eingerückt dargestellt wird:

Passe das Maven-Konfigurationsfile (pom.xml) an:

1
2
3
4
5

<dependency>
  <groupId>io.github.cdimascio</groupId>
  <artifactId>dotenv-java</artifactId>
  <version>3.0.0</version>
</dependency>

Falls du Probleme hast, die Maven-Dependency hinzuzufügen, prüfe, ob du mit dem VPN der SBB verbunden bist!

Unternehmensspezifische Inhalte

Dieser Abschnitt wird nur angezeigt, wenn SBB als Ausbildungsort ausgewählt ist.

Veraltete Shortcodes

Folgende Shortcodes sind deprecated und sollen nicht mehr verwendet werden:

ChatGPT Prompt für die it-ninjas Dokumentation

Damit ChatGPT eine Markdown-Datei im it-ninjas Stil überarbeiten kann, sollte der Prompt mehr enthalten als nur technische Anweisungen. Ziel ist es, den charakteristischen Ton, die Zielgruppe und die Formatkonventionen zu berücksichtigen.

Hier ein vollständiger Prompt, den du nutzen oder anpassen kannst:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

Bitte überarbeite folgenden Markdown-Text für das it-ninjas Projekt.

### Zielgruppe:
- Lernende (oft ohne Vorwissen), die Java, IntelliJ oder andere Tools im Rahmen der Ausbildung verwenden
- Ziel ist, Inhalte **leicht verständlich**, **freundlich**, **ermutigend** und **strukturiert** zu präsentieren

### Ton & Stil:
- **Du-Form** verwenden, nicht „man“
- Aktiv, klar, ermutigend, niemals belehrend
- Ein bisschen Witz ist erlaubt, aber stets respektvoll und professionell
- Sprich direkt zur Leserin oder zum Leser („Du lernst...“, „So kannst du...“)

### Struktur & Formatierung:
- Abschnitt **„Ziele“** zu Beginn mit klaren Bulletpoints
- Nach den Zielen ein `⏱️ Geschätzte Lesezeit: X Minuten
`-Block (geschätzte Lesezeit, auf 5 Minuten aufrunden,
  konservativ geschätzt bei 100 Wörtern/Min)
- Abschnittsüberschriften auf der zweiten Ebene (`##`) beginnen
- **Maximale Zeilenlänge 120 Zeichen** (auch in Codeblöcken)
- Wo möglich, passende Shortcodes einsetzen (`ninja`, `lablink`, `aufgabe`, `code`, etc.)
- Veraltete Shortcodes vermeiden (`SBBOnly` z. B.)

### Zusätzliche Hinweise:
- Technische Inhalte wenn möglich mit Beispielen, Bildern oder Code ergänzen
- Am Ende des Dokuments **freundlich abschliessen** (z. B. „Viel Erfolg!“)
- Falls `## Ziele` schon vorhanden ist, nicht duplizieren

### Prettier konform
- Kursiv mit `_..._`, nicht mit `*...*`

### Markdown-Text:
---
(dein Markdown-Text hier)
---

Damit erhalten auch andere Autor:innen dieselbe Qualität wie du – und ChatGPT arbeitet im gewünschten it-ninjas-Stil.

Hinweise zur Formatierung

• Achte auf maximal 120 Zeichen pro Zeile.
• Verwende aktive Formulierungen.
• Halte Inhalte zielgruppengerecht und gut strukturiert.
• Nutze die zur Verfügung gestellten Shortcodes, um Wiederverwendbarkeit und Einheitlichkeit sicherzustellen.
• Zwischen zwei Kapiteln kommt eine Linie (---)
• In allen Codebeispielen gilt: Kommentare, Variablennamen, Methodennamen und Code-Sprache sind auf Englisch.
• Die Ausgabe auf der Konsole oder dem Bildschirm darf hingegen auf Deutsch sein (z. B. System.out.println("Hallo Welt")).