CLI-Überprüfung der Benutzerfreundlichkeit (UX)
Überprüft eine CLI anhand eines festgelegten Bewertungsrasters aus der Perspektive eines Nicht-Entwicklers, der sie noch nie verwendet hat.
Wann verwenden
- „CLI UX Audit“ / „Review my CLI“ / „Ist diese CLI intuitiv?“
- Vor jeder CLI-Veröffentlichung
- Nach dem Hinzufügen oder Ändern eines CLI-Befehls
Der Rahmen
Jede Befehlsausgabe muss drei Fragen beantworten: Was ist die Situation? · Was sind die nächsten Schritte? · Was kann ich tun?
Qualitätsmaßstab: Ein Befehl endet so, wie Codex eine Sitzung beendet – eine Zeile mit einfachem Status, dann der genaue nächste Befehl, in einer deutlichen Farbe dargestellt, sodass das Auge auf „gib das ein“ fällt.
Bewertungsraster (jeden Befehl gegen alle 7 Kriterien prüfen)
- Nächster Schritt vorhanden. Jeder Erfolgs-/Endzustand endet mit dem nächsten Befehl oder einem expliziten „Du bist fertig.“ Kein Befehl bleibt stumm hängen.
- Befehle sind farblich hervorgehoben. Ausführbare Befehle werden in einer einheitlichen Akzentfarbe (Cyan + fett) dargestellt. Niemals reiner Text, niemals wörtliche Backticks.
- Keine rohen Interna. Keine Enum-Werte, Zustandscodes oder Fachjargon in der Benutzerausgabe. Menschliche Wörter plus eine einzeilige Legende („dirty“ wird zu „lokale Änderungen“).
- Kein stiller Hänger. Langlaufende oder stdio-Befehle kündigen sich auf einem TTY an, sodass das Terminal nie eingefroren aussieht.
- Konsistente Grundelemente. Ein Zeichensatz, ein Zeilen-/Tabellenhelfer, ein Block für den nächsten Schritt, der von allen Befehlen gemeinsam genutzt wird und nicht pro Befehl neu erfunden wird.
- Fehler enthalten die Lösung. Jeder Fehler nennt den genauen Befehl, der das Problem behebt.
- Geführter erster Start. Ein bloßer Aufruf oder ein nicht angemeldeter Zustand zeigt eine nummerierte Schnellstartanleitung.
So wird es durchgeführt
- Erfasse jeden Befehl und jeden Ausgabepfad. Lies den Quellcode, nicht nur
--help. - Gehe für jeden Befehl den Erfolgspfad, jeden Fehlerpfad und leere Zustände durch.
- Bewerte anhand der 7 Kriterien. Zitiere
Datei:Zeilefür jeden Befund. - Schreibe bei Fehlschlag das konkrete Vorher/Nachher mit den genauen Zeichenketten.
- Ausgabe: übergreifende Probleme, eine Tabelle pro Befehl, priorisierte Vorher/Nachher-Korrekturen und ein Ausführungsplan.
Ausgabeformat
Ein Ergebnisdokument: TL;DR und Kernproblem, Tabelle mit übergreifenden Problemen, Befunde pro Befehl, Vorher/Nachher für jede Korrektur, Ausführungsplan. Schreibe niemals „sieht gut aus“, ohne den tatsächlichen Ausgabepfad durchgegangen zu sein, der dies belegt.