Files
Ustagammon/docs/scenarios/README.md
T

1.4 KiB

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.

Tant que le domaine n'existe pas, les scénarios se déroulent à la main : ils servent alors de guide de test.

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