Schreibguide

Diese Seite hilft dem Team, spaeter konsistente, nutzerfreundliche Dokumentation zu schreiben.

Stil

• Schreibe fuer Anwenderinnen und Anwender, nicht fuer Entwickler.
• Erklaere zuerst den Nutzen, danach Details.
• Verwende kurze Abschnitte und konkrete Beispiele.
• Nutze Screenshots fuer sichtbare Oberflaechen und Tabellen fuer Vergleiche.
• Vermeide interne Begriffe wie DTO, Repository oder Spring-Service.

Bilder verwenden

Lege Bilder unter docs/assets/images ab. MkDocs kopiert diesen Ordner beim Build automatisch in die Website.

Ein Bild bindest du relativ zur aktuellen Markdown-Datei ein:

![Beschreibung des Screenshots](assets/images/calendar-overview.png)

Aus Unterordnern heraus gehst du eine Ebene zurueck:

![Aufgabenliste](../assets/images/task-list.png)

Empfohlene Dateinamen

• calendar-overview.png
• task-list.png
• create-task-dialog.png
• planning-conflict.png

Gute Bildregeln

• Nutze PNG fuer Screenshots.
• Nutze SVG fuer Logos oder einfache Grafiken.
• Schneide Screenshots so zu, dass der relevante Bereich klar sichtbar ist.
• Vermeide echte personenbezogene Daten in Beispielen.
• Gib jedem Bild einen aussagekraeftigen Alternativtext.