Aller au contenu

Explication

Conventions de nommage

Nommez les types, propriétés et relations de façon stable et compréhensible.

2 min

Utilisez des termes métier compréhensibles et des identifiants techniques stables. Le nom technique d'une propriété et son libellé affiché remplissent deux fonctions distinctes.

Types et relations

Nommez les types au singulier : Client, Commande. Préférez le concept métier au nom d'une table technique. Ajoutez un qualificatif lorsqu'il distingue réellement deux concepts, pas uniquement deux applications sources.

Nommez les relations avec un verbe et vérifiez le sens : Client passe Commande. Documentez la cardinalité et le sens inverse. Un nom générique « lié à » ne permet pas de comprendre l'usage.

Noms techniques de propriétés

Dans le formulaire de propriété, le nom doit commencer par une lettre et contenir uniquement les lettres A–Z ou a–z, les chiffres et _. Les espaces, accents et tirets ne sont pas acceptés dans ce champ.

Nom techniqueLibellé lisibleSignification
dateEcheanceDate d'échéanceDate attendue dans le fuseau précisé
dureeMinutesDurée en minutesValeur numérique exprimée en minutes
client_idIdentifiant client sourceRéférence du système source indiqué
montantMontantValeur à lire avec la propriété devise

Évitez date2 ou value : documentez le sens et l'unité. Pour les noms affichés et descriptions, utilisez les accents et la terminologie habituelle de vos utilisateurs.

Vérifier la stabilité

Créez une propriété, enregistrez puis rouvrez le type. Contrôlez le nom technique dans la définition JSON et le libellé dans le formulaire. Testez une instance avec une valeur représentative.

Changer un libellé ne doit pas être confondu avec renommer une clé utilisée par une API, un mapping ou un agent. Avant de renommer, identifiez ces dépendances et testez-les : voir Faire évoluer un type.

La forme correcte d'un identifiant ne garantit ni son unicité métier ni la correspondance entre plusieurs sources. Définissez ces règles séparément dans votre modèle.

Cette page vous a-t-elle permis d’atteindre votre objectif ?