update
This commit is contained in:
@@ -8,10 +8,22 @@ Abweichung als Problem und schlägt einen korrigierten Text vor.
|
||||
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`
|
||||
|
||||
## 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.
|
||||
|
||||
- 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`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
## Badge der Karte
|
||||
|
||||
Feld `badge`. Genau zwei Werte erlaubt: `kern` oder `optional`.
|
||||
Feld `badge`.
|
||||
|
||||
- `kern`: ohne die Karte ist das Projekt nicht benutzbar
|
||||
- `optional`: nützlich, aber verzichtbar
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Feld `regeln`, wenn `funktion` leer ist. Gilt für die ganze Karte.
|
||||
|
||||
- Eine Zeile je Regel, höchstens 10 Wörter
|
||||
- Eine Zeile je Regel
|
||||
- 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
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
Feld `titel`, wenn `funktion` leer ist.
|
||||
|
||||
- Höchstens 3 Wörter
|
||||
- Substantiv, oder Objekt mit Verb im Infinitiv
|
||||
- Benennt die Sache, kein ganzer Satz
|
||||
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Feld `regeln`, wenn `funktion` gesetzt ist. Gilt nur für diese Funktion.
|
||||
|
||||
- Eine Zeile je Regel, höchstens 10 Wörter
|
||||
- Eine Zeile je Regel
|
||||
- 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
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Feld `testen`. Gibt es nur bei Funktionen, nie auf Kartenebene.
|
||||
|
||||
- Eine Zeile je Schritt, höchstens 8 Wörter
|
||||
- Eine Zeile je Schritt
|
||||
- Schritte in Reihenfolge der Bedienung
|
||||
- Kein Schritt der Bedienung fehlt
|
||||
- Letzte Zeile beschreibt den Endzustand, keine Handlung
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
Feld `titel`, wenn `funktion` gesetzt ist.
|
||||
|
||||
- Höchstens 5 Wörter
|
||||
- Kurzsatz aus Objekt und Verb im Infinitiv
|
||||
- Genau eine Tätigkeit
|
||||
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user