Bonnes pratiques de création

Dernière mise à jour : 2023-11-01
  • Créé pour :
  • Developer
    User
    Admin
    Leader

Vue d’ensemble

Cette page décrit les règles à suivre au moment de la création de la page de documentation de destination, afin de vous assurer qu’elle respecte les normes de qualité de la documentation Adobe Experience Platform.

Directives générales

  • Lorsque vous remplissez le modèle de la documentation de destination, consultez le guide du contributeur d’Adobe pour en savoir plus sur les liens, les tableaux, la syntaxe markdown prise en charge, les guides de rédaction, etc.
  • N’incluez pas d’observations ni d’estimations dans la documentation du produit.
  • Dans la documentation Experience Platform, les auteurs Adobe mettent les commandes de l’interface utilisateur en gras, comme suit :
    • Accédez à Connexions > Destinations, puis sélectionnez l’onglet Catalogue. Consultez ce tutoriel sur les destinations pour en savoir plus sur la manière dont les commandes de l’interface utilisateur sont documentées.

Règle de style

IMPORTANT

Consultez le document Guide de rédaction pour la documentation Adobe avant de commencer à créer la page de documentation de destination.

  • Faites des phrases courtes et allez à l’essentiel. Si la phrase comporte plus de 20 mots ou plusieurs virgules, envisagez de la diviser en plusieurs phrases, car elles peuvent être particulièrement difficiles à lire.
  • Ne soyez pas trop poli. Évitez d’utiliser « veuillez » ou « nous vous prions… » dans la documentation technique.

Liaison

Suivez le modèle de documentation fourni et ne modifiez pas les liens existant dans le modèle. Quand vous ajoutez de nouveaux liens, consultez la section Utilisation de liens dans la documentation dans le guide du contributeur.

Directives relatives à l’image de marque

  • AEP n’est pas un terme approuvé pour le public. Utilisez Adobe Experience Platform au moment de la première utilisation, puis Experience Platform, et enfin Platform.
    • Ne pas utiliser : avant d’exporter des données d’AEP vers YourDestination, veillez à lire et à remplir ces conditions préalables.
    • Utiliser : avant d’exporter des données d’Adobe Experience Platform vers YourDestination, veillez à lire et à remplir ces conditions préalables.

Images et copies d’écran

  • Pour plus d’informations sur comment créer un lien vers des images, consultez le guide du contributeur.
  • Quand vous utilisez des copies d’écran, veillez à copier l’ensemble de l’écran de l’interface utilisateur de Platform.
  • Quand vous marquez des images pour mettre en évidence une certaine commande ou un certain libellé sur la page, essayez de respecter le style de marquage utilisé par l’équipe de documentation Experience Platform. Observez comment la base de profil est mise en évidence dans cette copie d’écran.
  • Utilisez des images au format png.
  • N’utilisez pas de copies d’écran numérotées comme noms de fichier. Les noms des fichiers images doivent être descriptifs.
    • Ne pas utiliser : 1.png, 2.png, 3.png
    • Utiliser : yourdestination-authentication-details.png, yourdestination-destination-details.png
  • Utilisez du texte de remplacement pour toutes les images que vous ajoutez à la documentation et veillez à respecter les règles de grammaire dans le texte de remplacement.
    • Ne pas utiliser : détails de la connexion de destination
    • Utiliser : image de l’interface utilisateur de Platform affichant les détails de connexion de destination renseignés.

Processus

  • Le modèle de documentation est mis à jour périodiquement, en fonction des commentaires du partenaire. Avant de commencer à créer de la documentation pour la destination, veillez à avoir téléchargé la dernière version du modèle.
  • Rédigez la documentation et créez la requête de tirage de la documentation (PR) à partir d’une branche de votre secteur, autre que la branche principale. Consultez la section « Soumission d’une destination à réviser » au moment de la création dans l’interface GitHub ou votre environnement local.

Sur cette page