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
• Maustasten als LMB, RMB, MMB
• Ein Menüeintrag wird wörtlich zitiert: Klick auf "Feature entfernen"
• Ein Kommando wird wörtlich zitiert: Befehl "make install" ausführen
• Ein Zitat zählt als ein Wort und darf Sonderzeichen tragen
• Jeder Gegenstand heißt überall gleich

Bedienung, nicht Bauweise

Karten beschreiben, was gilt und wie man es auslöst. Wie es aussieht und wie es innen gebaut ist, gehört nicht dazu.

• Keine Icons, keine Zeichen als Namen
• Keine Farben
• Keine Positionen wie rechts oben oder unter dem Titel
• Kein Layout: Rahmen, Spalten, Abstände, Breiten
• Erlaubt ist der Bereich: Kopfzeile, Hauptbereich, Projektliste
• Kein Aufbau eines Skripts, nur sein Aufruf
• Keine Dateinamen, Klassen oder Bibliotheken

Richtig: LMB auf die Einstufung · Rückfrage vor dem Entfernen Richtig: Befehl "make install" ausführen · Ein Aufruf genügt Falsch: Augen-Icon rechts oben · Kern blau umrandet · Marke rechts vom Titel Falsch: Das Skript legt einen Symlink in autostart (Bauweise)

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 Testschritte — ohne sie ist sie keine Funktion
• Titel einer Funktion endet auf ein Verb im Infinitiv
• Titel einer Funktion beginnt nicht mit einem Auslöser
• 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 außerhalb eines Zitats
• 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