planer2/backend/stil/allgemein.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

Gilt für jedes Feld.

• Sprache: Deutsch, Präsens, keine Anrede
• Icons heißen <Name>-Icon. Der Name darf ein Zeichen sein: x-Icon, +-Icon, Stift-Icon. Ein Doppelpunkt mit dem tatsächlichen Zeichen dahinter ist erlaubt (Nacht-Icon: ☾)
• Maustasten als LMB, RMB, MMB

Vom System gemessen

Diese Vorgaben prüft der Code selbst, exakt und für jede Zeile. Halte dich beim Schreiben daran — aber berufe dich nie darauf. Als regel sind sie nicht zulässig.

• Jede Funktion hat Ziel, Regeln oder Testschritte — nie nur einen Titel
• Titel einer Funktion endet auf ein Verb im Infinitiv
• Testschritte beschreiben genau einen Ablauf
• Kein Satzzeichen am Zeilenende, kein Punkt und kein Semikolon
• Keine Füllwörter. Die Liste ist abschließend: auch, noch, einfach, jeweils, ggf.
• Keine Klammern und keine Schrägstriche
• Titel der Karte: höchstens 3 Wörter
• Titel einer Funktion: höchstens 5 Wörter
• Ziel: höchstens 2 Sätze, je höchstens 12 Wörter
• Regeln: höchstens 10 Wörter je Zeile
• Testen: höchstens 8 Wörter je Zeile
• Badge: genau kern oder optional