Format JSON

Bonnes pratiques d'écriture

Comment formaliser un package, chaque étape et chaque variable pour qu'un processus soit lisible, sûr et maintenable.

Ces règles reprennent celles qu'applique l'assistant de Studio. Un processus qui les respecte se relit comme une procédure et se dépanne sans ouvrir le JSON.

Le package

Élément	Règle	Exemple
`name`	Verbe d'action + objet métier ; stable dans le temps.	« Traitement des factures fournisseurs »
`description`	Quoi, pour qui, avec quelle garde-fou, en 1 à 2 phrases.	« Lit les factures, les classe avec l'IA et demande une validation au-delà du seuil. »
`version`	Incrémentée à chaque publication.	`1.4.1`
`variables`	Tout ce qui change d'un environnement à l'autre (adresses, seuils, dossiers).	`url_portail`, `seuil`

Les étapes

Un label par intention métier, à l'infinitif : « Lire les factures du jour », pas « data.table ».
Des id parlants et stables (lire, classer, valider) : ils apparaissent dans les journaux et permettent la reprise.
Des cibles en français : « bouton Valider », « champ Montant », « lien Factures ». Le moteur auto-guérisseur s'en sert pour retrouver un élément qui a changé.
Une validation humaine (human.approve) juste avant toute action irréversible : payer, envoyer, comptabiliser, supprimer.
Aucune donnée inventée : une adresse ou un seuil inconnu devient une variable ({{url_portail}}).
Aucun secret dans le package : passez par le coffre (credential).
Terminez par un log.write récapitulatif.

Les variables

En snake_case, sans accent : montant_ttc, url_portail.
Nom au singulier pour un élément, au pluriel pour une liste : facture / factures.
Préfixez les résultats intermédiaires par leur rôle : reponse_creation, decision_paiement.

Les boucles et conditions

Placez flow.if immédiatement avant l'étape conditionnée.
Recomptez count de flow.foreach après chaque ajout ou suppression dans le corps.
Au-delà de trois étapes à conditionner, créez un sous-processus et appelez-le avec flow.call.

Relecture avant publication

Le package passe le Schéma JSON.
Simulation sans robot réussie.
Exécution réelle sur un environnement de test.
Chaque action irréversible est précédée d'une validation.
Aucun secret, aucune donnée personnelle réelle dans les valeurs par défaut.

Mis à jour le 28 octobre 2026