Skip to content
Apothem
Pipeline-Befehle

/ux-review

/ux-review — Developer-Experience-Review der CLI-Ergonomie, der Dokumentation und des Onboardings.

Rolle: UX-Prüfer Pipeline-Position: Festung

Developer-Experience-Review der CLI-Ergonomie, der Dokumentation und des Onboardings.

Kanonischer Aufruf

/ux-review

Mit Argumenten:

/ux-review [path/to/repo/] [--focus SURFACE] [--dry-run]

Eingaben

Bereitgestelltes Host-Repository mit einer README, Installationsskripten und einem CLI-Einstiegspunkt

Ausgaben

UX-Befunde unter _inputs/ux-review-findings.md

Nachgelagert

Die UX-Review-Stufe der Audit-Review-Sequenz

Workflow-Phasen

Der Befehl durchläuft fünf Phasen: Eingabeaufnahme, Durchlauf der CLI-Ergonomie, Audit des Installationsablaufs und der Fehlerwiederherstellung, Sweep der Auffindbarkeit der Dokumentation sowie Ausgabe der Befunde mit dem Validierungs-Gate.

Fehlermodi

SymptomUrsacheBehebung
Voraussetzung unvollständigAbhängige Phase nicht abgeschlossenSchließe zuerst die vorgelagerte Phase ab
Qualitätstor FAILDie Ausgabe erfüllt die Standards nichtBehebe die Ausgabe und führe erneut aus
Ziel nicht bereitgestelltDem Ziel fehlt die für Operatoren sichtbare OberflächeÜbergib das bereitgestellte Repository-Wurzelverzeichnis

Beispiele

# Dry-run to preview what would happen
/ux-review --dry-run

# Execute against a host repository
/ux-review path/to/repo/

Querverweise

On this page