Meilleures pratiques et directives pour des applications basées sur des modèles

Les applications pilotées par modèle sont une approche axée sur les composants pour le développement d’applications que les développeurs peuvent étendre pour obtenir une expérience beaucoup plus adaptée. Un developpeur qui personnalise des applications pilotées par modèle doit tenir compte des instructions et des meilleures pratiques établies.

Dans cette section, vous découvrez les problèmes identifiés, leur impact, et comprenez les instructions pour les résoudre. Nous vous donnerons des informations générales expliquant pourquoi les choses doivent être effectuées d’une certaine manière et comment éviter d’éventuels problèmes à l’avenir. Cette compréhension peut être bénéfique pour la convivialité, la prise en charge et les performances de votre environnement. La documentation d’instructions prend en charge les informations existantes dans les guides de développement et d’administration.

Note

À l’heure actuelle, seules les bonnes pratiques de script client sont documentées dans la table des matières et les autres seront éventuellement ajoutées. Ce document couvre la structure générale de l’apparence de la page des bonnes pratiques avec les sections et les lignes directrices.

Types de personnalisations ciblés

La documentation cible les types de personnalisations suivants :

• Conception d’une application basée sur un modèle
• Création des formulaires
• Scripts client
• Ressources Web

Sections

Chaque article d’instruction comprend la plupart ou toutes les sections suivantes :

• Titre : description des conseils
• Catégorie : un ou plusieurs domaines impactés si les conseils ne sont pas suivis
• Impact potentiel : niveau du risque (élevé, moyen ou faible) d’impact sur l’environnement si les conseils ne sont pas suivis
• Symptômes : indications possibles que les conseils n’ont pas été suivis
• Conseils : recommandations qui peuvent également contenir des exemples
• Modèles problématiques : description ou exemples de non-suivi des conseils
• Informations supplémentaires : détails de support pour une vue plus complète
• Voir aussi : informations de référence pour en savoir plus sur un point mentionné dans l’article

Catégories

Chaque article d’aide est classé selon une ou plusieurs des catégories suivantes :

• Utilisation : utilisation incorrecte d’une API, d’un modèle ou d’une configuration particuliers
• Conception : défauts de conception dans une personnalisation
• Performances : personnalisation ou modèle qui peut produire un impact négatif sur les performances dans des domaines tels que la gestion de la mémoire, l’utilisation du processeur, le trafic réseau ou l’expérience utilisateur
• Sécurité : vulnérabilités potentielles d’une personnalisation qui pourraient être exploitées dans un environnement d’exécution
• Upgrade Readiness : personnalisation ou modèle qui peut accroître le risque d’échec de la mise à niveau d’une version
• Migration en ligne : personnalisation ou modèle susceptible d’accroître le risque d’échec d’une migration en ligne
• Facilité de maintenance : personnalisation qui augmente inutilement le travail du développeur nécessaire pour apporter des changements, la fréquence des changements requis ou le risque d’introduire des régressions
• Capacité de prise en charge : personnalisation ou modèle qui ne respecte pas les exigences de prise en charge publiées, notamment l’utilisation d’API supprimées ou l’implémentation de techniques interdites