pascalandy/pseudocode-cas-utilisation

Pseudocode -- Cas d'utilisation métier (FR)

Rédiger un cas d'utilisation (CU) métier en français selon une grammaire pseudocode normalisée. Le document sépare le corridor principal (chemin nominal) des variantes (chemins alternatifs ancrés à une étape précise).

Distinct du skill pseudocode (flows UI en anglais). Ici on documente un processus métier multi-acteurs : qui fait quoi, dans quel système, dans quel ordre, avec quelles erreurs et refus possibles.

Workflow

1. Lire la demande / le contexte fourni.
2. Identifier la portée et formuler l'objectif en une phrase.
3. Lister les acteurs (humains + systèmes) avec étiquettes ETQ_NN.
4. Lister les préconditions (états vrais avant le déclencheur).
5. Écrire le déclencheur (geste qui démarre le CU).
6. Décomposer le scénario principal en étapes ÉTAPE N: TITRE.
7. Écrire les variantes et exceptions, chacune ancrée à une étape via son ID.
8. Lier chaque étape à ses variantes via // variantes: ALT_<CU>-E<N>, ....
9. Écrire les postconditions (états finaux, CU avals déclenchés).
10. Valider avec la checklist de complétude.

Squelette de document

---
name: <Titre du CU>
description: <Une phrase>
tags:
  - area/<domaine>
  - kind/project
  - topic/<sujet>
  - status/open
date_created: YYYY-MM-DD
date_updated: YYYY-MM-DD
---

## CU_<NUM> | <Titre court>

### Objectif

<Une phrase qui explique ce que le CU permet d'accomplir.>

### Acteurs

- ETQ_NN <NOM_ACTEUR>
- ETQ_NN <RÔLE> : <NOM>

### Préconditions

- <état vrai avant le déclencheur>
- ...

### Déclencheur

```js
(ACTION)=> DÉCLENCHEUR
  ()=> <ACTEUR> initie [...]
(SUCCÈS)=> <état observable après le déclencheur>
```

### Scénario principal

```js
(ACTION)=> ÉTAPE 1: TITRE EN MAJUSCULES
  ()=> ...
(SUCCÈS)=> affiche [...]
// variantes: ALT_<CU>-E1.1, ALT_<CU>-E1.2

(ACTION)=> ÉTAPE 2: ...
```

### Variantes et exceptions

```js
// ALT_<CU>-E1.1 -- ÉTAPE 1: <description courte>
(ACTION)=> <rappel du geste de l'étape>
(ERREUR)=> <condition> [...]
```

### Postconditions

```js
(SUCCÈS)=> Postconditions
  ()=> <état final 1>
  ()=> <état final 2>
```

Grammaire pseudocode

Utiliser ```js pour tous les blocs de pseudocode (coloration syntaxique propre).

Mots-clés (majuscules avec accents)

| Mot-clé | Usage | |---|---| | (ACTION)=> | Étape principale ou geste d'un acteur | | (SUCCÈS)=> | Résultat positif d'une étape ou état final | | (ERREUR)=> | Échec technique ou validation refusée | | (REFUS)=> | Refus humain ou refus d'autorisation | | (ATTENTE)=> | Opération longue / traitement en cours | | (SI)=> | Branche conditionnelle |

Symboles

| Symbole | Usage | |---|---| | ()=> | Sous-étape (indentée 2 espaces sous son parent) | | ["..."] | Libellé UI, message à l'écran, ID, valeur littérale | | {var} | Variable interpolée dans un libellé : ["Ticket #{num}"] | | 0o0o | Placeholder / TODO (lettres o, jamais des zéros) |

Règles de syntaxe

• Pas de backticks dans les blocs js.
• Pas de markdown gras (**...**) à l'intérieur des blocs.
• Guillemets droits (") seulement -- jamais « » ni "...".
• Mots-clés français exclusivement (pas de if, pas de while).

Convention d'étape

(ACTION)=> ÉTAPE N: TITRE EN MAJUSCULES
  ()=> ACTEUR fait quelque chose
  ()=> ACTEUR clique ["Libellé du bouton"]
(ATTENTE)=> opération en cours ["Message d'attente..."]
(SUCCÈS)=> affiche ["Confirmation"]
// variantes: ALT_<CU>-E<N>, ...

• L'en-tête (ACTION)=> ÉTAPE N: ... est au niveau racine (pas d'indentation).

• Les sous-actions sont indentées 2 espaces.

• (SUCCÈS)=>, (ATTENTE)=>, (SI)=> reviennent au niveau racine.

• (SUCCÈS)=> peut prendre la forme affiche ["..."] ou un titre descriptif (ex. (SUCCÈS)=> Postconditions).

• Une branche conditionnelle interne :

  (SI)=> condition
    ()=> sous-action de la branche
  (SUCCÈS)=> résultat de la branche
  

• L'annotation // variantes: apparaît immédiatement après le (SUCCÈS)=> final de l'étape, seulement si des variantes existent.

Convention de variante

// ALT_<CU>-E<N>[.M] -- ÉTAPE N: <description courte>
(ACTION)=> <rappel du geste de l'étape source>
(ERREUR)=> <cause> ["Message à l'utilisateur"]
  ()=> <action de récupération>

• Format d'ID : ALT_<CU>-E<N> ou ALT_<CU>-E<N>.<M> si plusieurs variantes pour la même étape.
• Numérotation .1, .2, ... quand collision.
• Démarrer par (ACTION)=> qui rappelle le geste de l'étape source (point d'ancrage visuel).
• Puis enchaîner (ERREUR)=>, (REFUS)=> ou (SUCCÈS)=> selon les chemins.

Convention d'acteur

### Acteurs

- ETQ_10 EMPLOYÉ
- ETQ_60 PORTAIL_DÉPENSES
- ETQ_50 SOLUTION : SYSTÈME_PAIE
- ETQ_15 Gestionnaire de l'employé (GESTIONNAIRE)

• Étiquette ETQ_NN toujours présente.
• Acteurs systèmes (portails, ordonnanceurs, entrepôts de données) listés au même niveau que les humains.
• Identifiants d'acteur en MAJUSCULES_AVEC_UNDERSCORES quand utilisés dans le pseudocode (ex. EMPLOYÉ, GESTIONNAIRE, ORDONNANCEUR).

Exemple condensé (CU_801)

Version courte d'un CU complet pour illustrer la grammaire en contexte. La version étendue se trouve dans references/exemple-01-note-de-frais.md.

## CU_801 | Soumettre une note de frais

### Acteurs

- ETQ_10 EMPLOYÉ
- ETQ_15 GESTIONNAIRE
- ETQ_18 FINANCE
- ETQ_60 PORTAIL_DÉPENSES
- ETQ_50 SYSTÈME_PAIE

### Préconditions

- employé enregistré dans PORTAIL_DÉPENSES
- compte bancaire valide au dossier
- gestionnaire désigné pour l'employé

### Déclencheur

```js
(ACTION)=> DÉCLENCHEUR
  ()=> EMPLOYÉ ouvre ["Nouvelle note de frais"] dans PORTAIL_DÉPENSES
(SUCCÈS)=> formulaire de saisie ouvert
```

### Scénario principal

```js
(ACTION)=> ÉTAPE 1: SAISIE DE LA NOTE
  ()=> EMPLOYÉ remplit ["date", "montant", "catégorie"]
  ()=> EMPLOYÉ joint ["reçu numérisé"]
  ()=> EMPLOYÉ clique ["Soumettre"]
(SUCCÈS)=> affiche ["Note no. {num} -- En attente d'approbation"]
// variantes: ALT_801-E1.1

(ACTION)=> ÉTAPE 2: APPROBATION
  ()=> GESTIONNAIRE clique ["Approuver"]
(SUCCÈS)=> affiche ["Approbation gestionnaire enregistrée"]
(SI)=> montant supérieur à 5000 $
  ()=> FINANCE clique ["Approuver"]
(SUCCÈS)=> affiche ["Approbation FINANCE enregistrée"]
// variantes: ALT_801-E2

(ACTION)=> ÉTAPE 3: PAIEMENT
  ()=> SYSTÈME_PAIE exécute le virement
(ATTENTE)=> exécution ["Paiement en cours..."]
(SUCCÈS)=> affiche ["Virement initié -- référence {ref}"]
```

### Variantes et exceptions

```js
// ALT_801-E1.1 -- ÉTAPE 1: Reçu manquant
(ACTION)=> EMPLOYÉ clique ["Soumettre"]
(ERREUR)=> aucun reçu joint ["Reçu obligatoire au-delà de 25 $"]
  ()=> retour à ["Formulaire de note"] avec ["Reçu à joindre"]

// ALT_801-E2 -- ÉTAPE 2: Refus de l'approbateur
(ACTION)=> GESTIONNAIRE ou FINANCE ouvre la note
(REFUS)=> approbation refusée
  ()=> modal ["Motif du refus obligatoire"]
  ()=> retour à ["Note no. {num}"] avec ["Note refusée -- motif : {raison}"]
```

### Postconditions

```js
(SUCCÈS)=> Postconditions
  ()=> virement initié vers l'EMPLOYÉ
  ()=> ligne comptable inscrite
  ()=> notification envoyée à l'EMPLOYÉ
```

Galerie d'exemples complets

Cas d'utilisation complets, à copier puis adapter. Chaque fichier est autonome (frontmatter + sections + pseudocode). Bonifier les exemples ou ajouter de nouveaux scénarios au fil du temps.

| Fichier | Cas d'utilisation | Patterns clés démontrés | |---|---|---| | references/exemple-01-note-de-frais.md | CU_801 -- Soumettre une note de frais | Approbation humaine, branche (SI) sur seuil, (REFUS), variantes multi-erreurs, déclenchement de CU aval. | | references/exemple-02-reinitialisation-mot-de-passe.md | CU_802 -- Réinitialiser un mot de passe (libre-service) | (ATTENTE) courriel, branche (SI) MFA, variante anti-énumération, validation multi-règles. | | references/exemple-03-synchronisation-nocturne.md | CU_803 -- Synchronisation nocturne d'inventaire | Déclencheur planifié (cron), acteurs majoritairement systèmes, retry exponentiel, escalade humaine, validation post-chargement. |

Pour ajouter un nouvel exemple : créer references/exemple-NN-<slug>.md (numéro séquentiel, slug court en kebab-case).

Règles d'écriture

• Une action par ligne. Jamais deux gestes dans la même ligne ()=>.
• Indentation 2 espaces pour sous-étapes et branches.
• Mots-clés français exclusivement. Pas de if, while, else en anglais.
• Acteurs en MAJUSCULES_AVEC_UNDERSCORES comme identifiants : EMPLOYÉ, GESTIONNAIRE, SYSTÈME_PAIE.
• Verbes au présent : clique, ouvre, remplit, affiche, joint.
• Libellés UI dans ["..."] systématiquement, même pour les messages courts.
• TODO / placeholder = 0o0o (lettres o, jamais des zéros).
• Texte brut dans les libellés : guillemets droits, pas de gras, pas de typographie courbe.

Anti-patterns

À éviter :

• Empiler plusieurs actions sur une ligne (()=> user remplit le formulaire, clique soumettre et reçoit confirmation).
• Utiliser if, while, else en anglais au lieu de (SI)=>, (ATTENTE)=>.
• Mélanger backticks (`action`, `click`) avec les mots-clés majuscules (ACTION)=> -- choisir un seul style (le nôtre est majuscules sans backticks).
• Variantes orphelines (sans ancrage // ALT_<CU>-E<N> -- ÉTAPE N: ...).
• IDs de variante non séquentiels par rapport aux étapes (ex. ALT_401-07 pour une variante de l'étape 2).
• Markdown gras (**...**) à l'intérieur des blocs js.
• Guillemets typographiques « » ou "..." dans les libellés.
• Mélanger zéros et lettres o dans le placeholder (utiliser 0o0o exactement).
• Oublier l'annotation // variantes: après une étape qui en possède.
• Numéroter les étapes sans le mot ÉTAPE ni le caractère : (ex. (ACTION)=> 1 SOUMISSION).

Checklist de complétude

| Élément | Question à se poser | |---|---| | Acteurs | Tous les acteurs (humains + systèmes) sont-ils listés avec ETQ_NN ? | | Préconditions | Quels états doivent être vrais avant le déclencheur ? | | Déclencheur | Quel geste démarre le CU ? Y a-t-il un (SUCCÈS)=> observable ? | | Étapes | Chaque étape a-t-elle un (ACTION)=> initial et un (SUCCÈS)=> final ? | | Variantes | Chaque chemin d'erreur, refus ou cas limite est-il couvert par une variante ancrée ? | | Liens étape-variante | L'annotation // variantes: apparaît-elle sur chaque étape qui en a ? | | Attente | Les opérations longues sont-elles marquées (ATTENTE)=> ? | | Branches internes | Les chemins alternatifs internes à une étape sont-ils traités avec (SI)=> ? | | Postconditions | Tous les états finaux et CU avals déclenchés sont-ils listés ? | | Syntaxe | Aucun backtick, aucun mot-clé anglais, aucun guillemet typographique ? |