planer2/backend/stil.md

Stil-Katalog für Karten

Verbindliche Vorgaben für alle Inhalte einer Feature-Karte. Der Prüfer meldet jede Abweichung als Problem und schlägt einen korrigierten Text vor.

Allgemein

• Sprache: Deutsch, Präsens, keine Anrede
• Kein Satzzeichen am Zeilenende (kein Punkt, kein Semikolon)
• Keine Füllwörter (auch, noch, einfach, jeweils, ggf.)
• Keine Klammern und keine Schrägstriche außer in Icon-Angaben
• Icons heißen <Name>-Icon, etwa x-Icon oder Stift-Icon; ein Doppelpunkt mit dem tatsächlichen Zeichen dahinter ist erlaubt (Nacht-Icon: ☾)
• Maustasten als LMB, RMB, MMB

Titel der Karte

• Höchstens 3 Wörter
• Substantiv, kein Verb
• Benennt die Sache, nicht die Tätigkeit

Richtig: Features · Karten prüfen · Darkmode Falsch: Features verwalten und anzeigen (zu lang, Tätigkeit)

Titel einer Funktion

• Höchstens 5 Wörter
• Kurzsatz aus Objekt und Verb im Infinitiv
• Genau eine Tätigkeit

Richtig: Feature erstellen · Anzeigemodus umschalten · Feature als Datei speichern Falsch: Erstellung von Features (Substantivierung) · Feature erstellen und öffnen (zwei Tätigkeiten)

Ziel

• Höchstens 2 Sätze, je höchstens 12 Wörter
• Beschreibt den Zweck, nicht die Bedienung
• Entfällt, wenn der Titel selbsterklärend ist — dann bleibt das Feld leer

Richtig: Gruppiert Informationen zu ähnlichen Funktionen Falsch: Klick auf die Karte öffnet den Vollmodus (Bedienung gehört zu Testen)

Regeln

• Eine Zeile je Regel, höchstens 10 Wörter
• Genau eine Aussage je Zeile; zwei Aussagen werden zu zwei Regeln
• Beschreibt eine Eigenschaft oder Bedingung, keinen Ablaufschritt
• Keine Aufzählung mit Komma oder „und" zweier gleichrangiger Aussagen

Richtig: Alphabetisch sortiert · Kern blau umrandet · x-Icon Falsch: Kern blau umrandet, Optional grün umrandet (zwei Aussagen) Falsch: Klick auf Badge (Ablaufschritt, gehört zu Testen)

Testen

• Eine Zeile je Schritt, höchstens 8 Wörter
• Schritte in Reihenfolge der Bedienung
• Letzte Zeile beschreibt den Endzustand, keine Handlung
• Handlungen als Nominalstil mit Maustaste oder Verb im Infinitiv

Richtig:

- Vollmodus öffnen
- RMB auf Funktion
- Klick auf "Funktion entfernen"
- Funktion entfernt

Falsch: letzte Zeile Klick zum entfernen (Handlung statt Endzustand)