neco Logo

Wie schreibe ich ein neues Tutorial?

Erste Schritte

  1. Kopiere den Ordner _example-tutorial
  2. Benenne ihn um z.B. neues-neco-feature-oder-so – keine Leerzeichen/Umlaute (wird zur URL des Tutorials)
  3. Öffne tutorial.md und fülle 'title' aus
  4. Schreibe dein Tutorial mit klaren Schritten
  5. Zusätzliche Bilder (Screenshots etc.) kommen in den Unterordner /images. Einbinden per ![Alt-Text](./images/screenshot.jpg). Siehe Screenshot-Beispiel weiter unten

Screenshots und Bilder im Tutorial

Manchmal sagt ein Bild mehr als 1000 Worte. Hier ein eingebettetes Bild:

Image showing a large tree on a green meadow

Tipps für gute Tutorial-Screenshots

  1. Hohe Auflösung: Mindestens 1080p, damit Details erkennbar sind
  2. Wichtige Bereiche markieren: Rote Kreise, Pfeile oder Hervorhebungen
  3. Saubere UI: Keine persönlichen Daten, Benachrichtigungen ausblenden
  4. Konsistente Größe: Ähnliche Crop-Bereiche für einheitliches Aussehen

Praktische Tipps

Häufige Fehler vermeiden

  • Zu lange Schritte: Lieber mehr, kleinere Schritte als wenige große
  • Veraltete Screenshots: Regelmäßig prüfen ob die UI noch aktuell ist

Bilder optimieren

Das System optimiert Bilder automatisch, aber du kannst helfen:

  • Größe: Originalauflösung hochladen, System erstellt automatisch verschiedene Größen
  • Dateigröße: Nicht zu stark komprimieren, Qualität ist wichtiger

Beispiel-Struktur:

---
title: 'Neue Funktion nutzen'
---

Kurze Beschreibung was das Tutorial erreicht und warum es nützlich ist.

## Schritt 1: Vorbereitung

Beschreibung des ersten Schritts...

![Screenshot des ersten Schritts](./images/step1.png)

## Schritt 2: Hauptaktion

Beschreibung des zweiten Schritts...

![Screenshot des zweiten Schritts](./images/step2.png)

## Schritt 3: Abschluss

Beschreibung des finalen Schritts...

![Screenshot des Ergebnisses](./images/result.png)

### Zusätzliche Hinweise

- Tipp 1
- Tipp 2
- Troubleshooting falls nötig