Ustagammon/docs/scenarios

Scénarios d'utilisation

La documentation utilisateur d'Ustagammon : un fichier par tâche réelle d'un joueur, écrit pour lui. Ces fichiers sont la seule source (ADR 0008) : l'application les met en forme comme pages d'aide, et ils sont exécutés comme tests d'intégration sur le domaine et le moteur réel.

make site copie ce dossier dans le site publié (docs/scenarios/) ; l'aide de l'application (bouton « Aide ») lit ces copies à l'exécution (app/src/ui/help.ts). Les fichiers affichés dans l'aide sont ceux de la liste FEATURES de help.ts.

make test les exécute avec Cucumber : les étapes, définies dans app/tests/steps/, pilotent le domaine branché sur le vrai moteur WebAssembly, avec des dés imposés pour que chaque exécution soit identique. Une étape sans définition fait échouer les tests.

Format

Gherkin standard (.feature), en français, validé par l'analyseur officiel de Cucumber (make test) :

# language: fr
Fonctionnalité: <la tâche>

  Un court paragraphe qui explique au joueur à quoi elle sert.

  Scénario: <un cas précis>
    Étant donné que <la situation de départ>
    Quand <ce que fait le joueur>
    Alors <ce qu'il constate>
    Et <autre constat>

Règles d'écriture :

• la deuxième personne (« vous ») et les mots du glossaire (docs/glossaire/) ;
• des intentions, pas des gestes d'interface : « vous commencez une nouvelle partie », pas « vous touchez le bouton Nouvelle partie ». Le même scénario reste vrai quelle que soit l'interface, et peut piloter directement le domaine ;
• des constats vérifiables par le joueur, sans détail technique.

Scénarios

Fichier	Tâche	Depuis
jouer-une-partie.feature	Jouer une partie contre l'ordinateur	Étape 0d
mes-parties.feature	Retrouver mes parties, leurs branches, les exporter en SGF	Étape 1b
regler-l-application.feature	Régler l'application (menu)	Étape 0e