ADR 0008 : glossaire et scénarios, source unique pour le code, l'aide et les tests
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
463bc6f553
commit
77ca5a60ca
@@ -0,0 +1,30 @@
|
||||
# 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 affiche comme pages d'aide, et ils servent de tests de bout
|
||||
en bout.
|
||||
|
||||
Tant que l'outil d'exécution n'est pas choisi (avec le socle, fin de
|
||||
l'étape 0), les scénarios se déroulent à la main : ils servent alors de guide
|
||||
de test.
|
||||
|
||||
## Format
|
||||
|
||||
Markdown avec Gherkin (`.feature.md`), étapes en français :
|
||||
|
||||
- `# Fonctionnalité : <la tâche>`, puis un court paragraphe qui explique à quoi
|
||||
elle sert, pour le joueur ;
|
||||
- `## Scénario : <un cas précis>` ;
|
||||
- des étapes en liste : `* Étant donné …`, `* Quand …`, `* Et …`, `* Alors …`.
|
||||
|
||||
Règles d'écriture : la deuxième personne (« vous »), les mots du glossaire
|
||||
(`docs/glossaire/`), des étapes que le joueur peut faire et vérifier lui-même,
|
||||
pas de détail technique. La syntaxe exacte sera validée avec l'outil
|
||||
d'exécution.
|
||||
|
||||
## Scénarios
|
||||
|
||||
| Fichier | Tâche | Depuis |
|
||||
| --- | --- | --- |
|
||||
| [jouer-une-partie.feature.md](jouer-une-partie.feature.md) | Jouer une partie contre l'ordinateur | Étape 0d |
|
||||
Reference in New Issue
Block a user