update
This commit is contained in:
@@ -8,22 +8,42 @@ Abweichung als Problem und schlägt einen korrigierten Text vor.
|
||||
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`
|
||||
- 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 Ziel, Regeln oder Testschritte — nie nur einen Titel
|
||||
- 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
|
||||
- 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
|
||||
|
||||
@@ -2,10 +2,11 @@
|
||||
|
||||
Feld `badge`.
|
||||
|
||||
- `kern`: ohne die Karte ist das Projekt nicht benutzbar
|
||||
- `optional`: nützlich, aber verzichtbar
|
||||
- `kern`: fehlt die Karte, kann die Anwendung nicht laufen
|
||||
- `optional`: fehlt die Karte, läuft die Anwendung weiter — mit weniger Funktionen
|
||||
- Die Prüffrage ist immer dieselbe: Streiche die Karte. Läuft der Rest noch?
|
||||
- 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)
|
||||
Richtig: `Projekt` ist kern · `Prüfung` ist optional
|
||||
Falsch: `Prüfung` als kern (ohne Prüfung läuft der Planer weiter)
|
||||
Falsch: `Sicherung` als kern, weil sie wichtig ist (wichtig heißt nicht tragend)
|
||||
|
||||
@@ -4,10 +4,13 @@ Feld `regeln`, wenn `funktion` leer ist. Gilt für die ganze Karte.
|
||||
|
||||
- Eine Zeile je Regel
|
||||
- Genau eine Aussage je Zeile; zwei Aussagen werden zu zwei Regeln
|
||||
- Sichert etwas zu, das man sonst nicht sieht
|
||||
- Beschreibt eine Eigenschaft oder Bedingung, keinen Ablaufschritt
|
||||
- Steht nicht schon in den Testschritten
|
||||
- Steht nicht schon als Regel der Karte
|
||||
- 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)
|
||||
Falsch: `Titel eingeben, dann bestätigen` (zwei Aussagen)
|
||||
Falsch: `LMB auf Badge` (Ablaufschritt, gehört zu Testen)
|
||||
Falsch: `Entsteht leer`, wenn die Testschritte keine Eingabe zeigen (schon sichtbar)
|
||||
|
||||
@@ -2,8 +2,12 @@
|
||||
|
||||
Feld `titel`, wenn `funktion` leer ist.
|
||||
|
||||
- Substantiv, oder Objekt mit Verb im Infinitiv
|
||||
- Benennt die Sache, kein ganzer Satz
|
||||
- Benennt einen Gegenstand, keine Tätigkeit
|
||||
- Sammelbegriff für die Funktionen der Karte
|
||||
- Jede Funktion der Karte handelt von diesem Gegenstand
|
||||
- Ein Wort, wenn es reicht
|
||||
|
||||
Richtig: `Features` · `Karten prüfen` · `Darkmode`
|
||||
Falsch: `Features verwalten und anzeigen` (zu lang, Tätigkeit)
|
||||
Richtig: `Projekt` · `Feature` · `Vorschlag` · `Planung`
|
||||
Falsch: `Karten prüfen` (Tätigkeit, das ist ein Funktionstitel)
|
||||
Falsch: `Verwaltung und Anzeige` (zwei Gegenstände)
|
||||
Falsch: `Gespräch` für eine Karte über Anweisungen (führt in die Irre)
|
||||
|
||||
@@ -2,8 +2,13 @@
|
||||
|
||||
Feld `ziel`, wenn `funktion` leer ist.
|
||||
|
||||
- Beschreibt den Zweck der Karte, nicht die Bedienung
|
||||
- Entfällt, wenn der Titel selbsterklärend ist — dann bleibt das Feld leer
|
||||
- Ergänzt den Titel, bis er eindeutig ist
|
||||
- Lässt erwarten, welche Funktionen auf der Karte stehen
|
||||
- Beginnt mit einem Verb
|
||||
- Erklärt den Titel nicht mit sich selbst
|
||||
- Beschreibt den Zweck, nie die Bedienung
|
||||
|
||||
Richtig: `Gruppiert Informationen zu ähnlichen Funktionen`
|
||||
Falsch: `Klick auf die Karte öffnet den Vollmodus` (Bedienung gehört zu Testen)
|
||||
Richtig: `Bündelt die Features einer Anwendung samt Verzeichnis`
|
||||
Falsch: `Gruppiert Features für ein Projekt` auf der Karte `Projekt` (zirkulär)
|
||||
Falsch: `Eine Änderung, die auf Zustimmung wartet` (Definition ohne Verb)
|
||||
Falsch: `LMB auf die Karte öffnet sie` (Bedienung gehört zu Testen)
|
||||
|
||||
@@ -4,10 +4,13 @@ Feld `regeln`, wenn `funktion` gesetzt ist. Gilt nur für diese Funktion.
|
||||
|
||||
- Eine Zeile je Regel
|
||||
- Genau eine Aussage je Zeile; zwei Aussagen werden zu zwei Regeln
|
||||
- Sichert etwas zu, das man sonst nicht sieht
|
||||
- Beschreibt eine Eigenschaft oder Bedingung, keinen Ablaufschritt
|
||||
- Steht nicht schon in den Testschritten
|
||||
- Steht nicht schon als Regel der Karte
|
||||
- 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)
|
||||
Richtig: `Titel ist Pflicht` · `Rückfrage vor dem Entfernen`
|
||||
Falsch: `Titel eingeben, dann bestätigen` (zwei Aussagen)
|
||||
Falsch: `LMB auf Badge` (Ablaufschritt, gehört zu Testen)
|
||||
Falsch: `Entsteht leer`, wenn die Testschritte keine Eingabe zeigen (schon sichtbar)
|
||||
|
||||
@@ -2,22 +2,40 @@
|
||||
|
||||
Feld `testen`. Gibt es nur bei Funktionen, nie auf Kartenebene.
|
||||
|
||||
Pflicht bei jeder Funktion. Eine Funktion ist etwas, das man für sich testen kann —
|
||||
ohne Ablauf ist sie nur eine Behauptung. Ziel und Regeln dürfen fehlen, Testen nie.
|
||||
Weiß man den Ablauf nicht, ist es keine Funktion, sondern eine offene Frage.
|
||||
|
||||
- Eine Zeile je Schritt
|
||||
- Genau ein Ablauf: handeln, handeln, Ergebnis
|
||||
- Nach dem Ergebnis folgt keine Handlung mehr
|
||||
- Schritte in Reihenfolge der Bedienung
|
||||
- Beginnt mit der Vorbedingung, wenn eine nötig ist
|
||||
- Kein Schritt der Bedienung fehlt
|
||||
- Jeder Schritt ist ohne Vorwissen ausführbar
|
||||
- Letzte Zeile beschreibt den Endzustand, keine Handlung
|
||||
- Handlungen als Nominalstil mit Maustaste oder Verb im Infinitiv
|
||||
- Handlungen als Nominalstil mit Maustaste, Kommando oder Verb im Infinitiv
|
||||
- Ein Kommando steht wörtlich im Zitat und ist so aufrufbar
|
||||
|
||||
Richtig:
|
||||
```
|
||||
- Vollmodus öffnen
|
||||
- RMB auf Funktion
|
||||
- Feature öffnen
|
||||
- RMB auf die Funktion
|
||||
- Klick auf "Funktion entfernen"
|
||||
- Bestätigen
|
||||
- Funktion entfernt
|
||||
```
|
||||
Falsch: letzte Zeile `Klick zum entfernen` (Handlung statt Endzustand)
|
||||
|
||||
Auf der Kommandozeile gilt dasselbe — der Aufruf ist die Handlung:
|
||||
```
|
||||
- Befehl "make install" ausführen
|
||||
- Abmelden und wieder anmelden
|
||||
- Anwendung läuft automatisch
|
||||
```
|
||||
Falsch: `Installationsskript starten` (sagt nicht, wie)
|
||||
Falsch: `Der Prüfschritt kopiert die Desktop-Datei` (Bauweise statt Bedienung)
|
||||
Falsch: letzte Zeile `Klick zum Entfernen` (Handlung statt Endzustand)
|
||||
Falsch: `Funktion entfernen wählen` (sagt nicht, wo)
|
||||
|
||||
Falsch, weil zwei Abläufe in einer Funktion stehen:
|
||||
```
|
||||
|
||||
@@ -3,9 +3,18 @@
|
||||
Feld `titel`, wenn `funktion` gesetzt ist.
|
||||
|
||||
- Kurzsatz aus Objekt und Verb im Infinitiv
|
||||
- Beschreibt etwas, das man für sich testen kann
|
||||
- Nennt den Gegenstand der Karte, wenn das nicht lügt
|
||||
- Genau eine Tätigkeit
|
||||
- Endet auf ein Verb im Infinitiv
|
||||
- Nennt eine Handlung, keinen Bereich, keinen Zustand
|
||||
- Die Handlung löst ein Mensch aus, nicht das System
|
||||
- Nennt die Wirkung, nie den Auslöser — der steht in den Testschritten
|
||||
|
||||
Richtig: `Feature erstellen` · `Anzeigemodus umschalten` · `Feature als Datei speichern`
|
||||
Falsch: `Erstellung von Features` (Substantivierung) · `Feature erstellen und öffnen` (zwei Tätigkeiten) · `Galerie im Modal` (ein Bereich) · `Preis aktualisiert` (ein Zustand) · `In den Warenkorb` (kein Verb)
|
||||
Richtig: `Feature anlegen` · `Vorschlag annehmen` · `Sicht wechseln`
|
||||
Richtig: `Anwendung installieren` · `Autostart aktivieren` · `Tests ausführen`
|
||||
Falsch: `Erstellung von Features` (Substantivierung)
|
||||
Falsch: `Feature anlegen und öffnen` (zwei Tätigkeiten)
|
||||
Falsch: `Galerie im Modal` (ein Bereich) · `Preis aktualisiert` (ein Zustand)
|
||||
Falsch: `Änderung markieren` (das System markiert, gehört in die Regeln)
|
||||
Falsch: `Befehl "make install" ausführen` (der Auslöser, gehört zu Testen)
|
||||
Falsch: `LMB auf Speichern` (der Auslöser, gehört zu Testen)
|
||||
|
||||
@@ -2,8 +2,12 @@
|
||||
|
||||
Feld `ziel`, wenn `funktion` gesetzt ist.
|
||||
|
||||
- Beschreibt den Zweck der Funktion, nicht die Bedienung
|
||||
- Entfällt, wenn der Funktionstitel selbsterklärend ist — dann bleibt das Feld leer
|
||||
- Ergänzt den Titel um das Warum
|
||||
- Beginnt mit einem Verb
|
||||
- Entfällt, wenn der Titel selbsterklärend ist — dann bleibt das Feld leer
|
||||
- Wiederholt den Titel nicht
|
||||
- Beschreibt den Zweck, nie die Bedienung
|
||||
|
||||
Richtig: `Beschreibt kurz das Kernziel der Funktion`
|
||||
Falsch: `Klick auf Regeln der Funktion` (Bedienung gehört zu Testen)
|
||||
Richtig: `Trennt tragende von verzichtbaren Features`
|
||||
Falsch: `Legt die Vision an` auf `Vision anlegen` (wiederholt den Titel)
|
||||
Falsch: `LMB auf Regeln der Funktion` (Bedienung gehört zu Testen)
|
||||
|
||||
Reference in New Issue
Block a user