Meilleures pratiques et directives pour des applications basées sur des modèles
Les applications basées sur des modèles est une approche basée sur le composant du développement d’application qui peut être étendu par un développeur pour obtenir une expérience beaucoup plus adaptée. Tout en personnalisant des applications basées sur des modèles, le développeur doit être au courant des instructions et des meilleures pratiques établies.
Dans cette section vous découvrirez les problèmes que nous avons identifiés, leur impact, ainsi que les instructions pour les résoudre. Nous expliquerons le contexte expliquant la raison des tâches à effectuer d’une certaine manière pour anticiper les problèmes potentiels à l’avenir. Cela peut être bénéfique pour la convivialité, la capacité de 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.
Notes
À 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 - le niveau de risque (élevé, moyen ou faible) d’affecter l’environnement en ne suivant pas les instructions
- Symptômes - Indications possibles que des instructions n’a pas été suivies
- Recommandation - Recommandations qui peuvent également contenir plusieurs exemples
- Schémas problématiques - Description ou exemples de non respect des instructions
- 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 schéma qui peut avoir un impact négatif sur les performances dans les domaines comme 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 dans une personnalisation qui peuvent être exploitées dans un environnement d’exécution
- Vérification de la disponibilité - Personnalisation ou schéma qui peuvent augmenter le risque d’avoir un échec de mise à niveau de version
- Migration en ligne - Personnalisation ou schéma qui peuvent augmenter le risque d’avoir un échec de la migration en ligne
- Maintenabilité – Personnalisation qui augmente inutilement la quantité d’effort requise du développeur pour effectuer des modifications, la fréquence des modifications nécessaires, ou la possibilité d’importer 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
Notes
Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)
Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).