Bonnes pratiques de création

Présentation

Cette page décrit les règles que vous devez suivre lorsque création de votre documentation de destination pour vous assurer qu’elle respecte les normes de qualité de la documentation Adobe Experience Platform.

Directives générales

  • Lorsque vous renseignez la variable modèle pour consulter la documentation de votre destination, reportez-vous au guide du contributeur d’Adobe pour plus d’informations sur liaison, tables, la variable syntaxe markdown prise en charge, écriture de conseils, etc.
  • N’incluez pas d’observations et d’estimations dans la documentation du produit.
  • Dans la documentation Experience Platform, les auteurs Adobe utilisent mise en forme gras pour faire référence aux commandes de l’interface utilisateur, comme suit :
    • Accédez à Connexions > Destinations, puis sélectionnez la variable Catalogue . Consultez un exemple de la manière dont les commandes de l’interface utilisateur sont documentées dans une tutoriel sur les destinations.

Liaison

Veuillez suivre le modèle de documentation fourni et ne pas modifier les liens existants dans le modèle. Lorsque vous incluez de nouveaux liens, lisez utilisation de liens dans la documentation dans le guide du contributeur.

Indications de marque

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

Images et captures d’écran

  • Pour plus d’informations sur Comment créer un lien vers des images, reportez-vous au guide du contributeur.
  • Lorsque vous utilisez des captures d’écran, veillez à ce que votre capture d’écran capture l’ensemble de l’écran de l’interface utilisateur de Platform.
  • Lorsque vous marquez des images pour mettre en évidence un certain contrôle ou libellé sur la page, essayez de suivre le style de balisage utilisé par l’équipe de documentation Experience Platform. Notez comment la fonction basée sur Profile est mise en surbrillance dans cette capture d’écran.
  • Veuillez utiliser png format des images.
  • N’utilisez pas de captures d’écran numérotées comme noms de fichier. Les noms des fichiers image doivent être descriptifs.
    • Ne pas utiliser: 1.png, 2.png, 3.png
    • Utilisez: yourdestination-authentication-details.png, yourdestination-destination-details.png
  • Veuillez utiliser du texte de remplacement pour toutes les images que vous ajoutez à la documentation et utiliser une grammaire correcte dans le texte de remplacement.
    • Ne pas utiliser: Détails de la connexion de destination
    • Utilisation: Image de l’interface utilisateur de Platform, affichant les détails de connexion de destination renseignés.

Processus

  • Le modèle de documentation est rarement mis à jour, en fonction des commentaires des partenaires. Avant de commencer à créer de la documentation pour votre destination, assurez-vous d’avoir téléchargé la dernière version du modèle.
  • Créez la documentation et créez la demande d’extraction de documentation (PR) à partir d’une branche de votre double. autre que la branche principale. Reportez-vous à la section Destination de l’envoi pour la révision lors de la création dans le Interface de GitHub ou votre environnement local.

Sur cette page