This commit is contained in:
team3
2026-07-27 11:29:57 +02:00
parent 15ad6dfe8a
commit 1c8a4fd4fd
30 changed files with 1133 additions and 173 deletions

17
backend/stil/allgemein.md Normal file
View File

@@ -0,0 +1,17 @@
# 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
- Kein Satzzeichen am Zeilenende (kein Punkt, kein Semikolon)
- Keine Füllwörter. Die Liste ist abschließend: auch, noch, einfach, jeweils, ggf.
- Keine Klammern und keine Schrägstriche außer in Icon-Angaben
- 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`

View File

@@ -0,0 +1,11 @@
## Badge der Karte
Feld `badge`. Genau zwei Werte erlaubt: `kern` oder `optional`.
- `kern`: ohne die Karte ist das Projekt nicht benutzbar
- `optional`: nützlich, aber verzichtbar
- Die Einstufung muss zum Ziel der Karte passen
- Im Zweifel `kern`
Richtig: `Projekte` ist kern · `Darkmode` ist optional
Falsch: `Darkmode` als kern (das Projekt läuft ohne)

View File

@@ -0,0 +1,13 @@
## Regeln der Karte
Feld `regeln`, wenn `funktion` leer ist. Gilt für die ganze Karte.
- 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
- Ein Icon-Name allein ist eine gültige Regel
Richtig: `Alphabetisch sortiert` · `Verlassen speichert` · `Escape verwirft`
Falsch: `Kern blau umrandet, Optional grün umrandet` (zwei Aussagen)
Falsch: `Klick auf Badge` (Ablaufschritt, gehört zu Testen)

View File

@@ -0,0 +1,10 @@
## Titel der Karte
Feld `titel`, wenn `funktion` leer ist.
- Höchstens 3 Wörter
- Substantiv, oder Objekt mit Verb im Infinitiv
- Benennt die Sache, kein ganzer Satz
Richtig: `Features` · `Karten prüfen` · `Darkmode`
Falsch: `Features verwalten und anzeigen` (zu lang, Tätigkeit)

View File

@@ -0,0 +1,10 @@
## Ziel der Karte
Feld `ziel`, wenn `funktion` leer ist.
- Höchstens 2 Sätze, je höchstens 12 Wörter
- Beschreibt den Zweck der Karte, 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)

View File

@@ -0,0 +1,13 @@
## Regeln einer Funktion
Feld `regeln`, wenn `funktion` gesetzt ist. Gilt nur für diese Funktion.
- 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
- Ein Icon-Name allein ist eine gültige Regel
Richtig: `x-Icon` · `Kern blau umrandet` · `Aktualisiert den Dateinamen`
Falsch: `Kern blau umrandet, Optional grün umrandet` (zwei Aussagen)
Falsch: `Klick auf Badge` (Ablaufschritt, gehört zu Testen)

View File

@@ -0,0 +1,18 @@
## Testen einer Funktion
Feld `testen`. Gibt es nur bei Funktionen, nie auf Kartenebene.
- Eine Zeile je Schritt, höchstens 8 Wörter
- Schritte in Reihenfolge der Bedienung
- Kein Schritt der Bedienung fehlt
- 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)

View File

@@ -0,0 +1,10 @@
## Titel einer Funktion
Feld `titel`, wenn `funktion` gesetzt ist.
- 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)

View File

@@ -0,0 +1,10 @@
## Ziel einer Funktion
Feld `ziel`, wenn `funktion` gesetzt ist.
- Höchstens 2 Sätze, je höchstens 12 Wörter
- Beschreibt den Zweck der Funktion, nicht die Bedienung
- Entfällt, wenn der Funktionstitel selbsterklärend ist — dann bleibt das Feld leer
Richtig: `Beschreibt kurz das Kernziel der Funktion`
Falsch: `Klick auf Regeln der Funktion` (Bedienung gehört zu Testen)