Documenter la destination dans Adobe Experience Platform
Vue d’ensemble overview
Bienvenue à Adobe Experience Platform, ravi de vous compter parmi nous !
La documentation de la destination est la dernière étape avant qu’elle puisse être mise en ligne dans Adobe Experience Platform.
Cette section de documentation comprend les éléments suivants :
- Cette section contient des instructions détaillées pour créer une page de documentation pour votre nouvelle destination.
- un modèle à remplir pour votre destination ;
- Instructions générales sur l’utilisation de Markdown;
- Instructions spécifiques pour la version Markdown d’Adobe (la version Markdown d’Adobe est très similaire à la version standard de Markdown).
- Une page des bonnes pratiques pour vous aider à créer une page de documentation pour la page de destination, qui répond aux normes de qualité de la documentation Experience Platform.
Conditions préalables prerequisites
Pour créer de la documentation pour la destination conformément aux instructions de cet article, les éléments suivants sont nécessaires :
- Compte GitHub. Inscrivez-vous à GitHub si vous ne disposez pas encore d’un compte.
- Bureau GitHub. Si vous choisissez de créer la documentation dans votre environnement local, vous devez utiliser Bureau GitHub.
- Votre intégration à Adobe doit être en phase de test, avec votre destination déployée dans un environnement d’évaluation en Adobe Experience Platform.
Instructions générales pour créer de la documentation pour la destination dans Adobe Experience Platform high-level-instructions
À un niveau élevé, pour créer de la documentation pour la destination, vous devez créer un branchement du référentiel de documentation Adobe Experience Platform et modifier le modèle de documentation fourni dans une nouvelle branche. Utilisez le modèle fourni par Adobe pour créer une page de destination. Ouvrez une requête de tirage (PR) lorsque vous êtes prêt. Pour ce faire, reportez-vous aux instructions ci-dessous, dans la section Procédure de création de votre page de destination.
Modèle de documentation documentation-template
Pour vous aider à créer votre page de documentation, Adobe a prérempli un modèle de documentation . Plus bas, vous trouverez des instructions sur la modification du modèle et l’ouverture d’une requête d’extraction. L’équipe de documentation d’Adobe examinera et publiera la documentation de votre nouvelle destination.
Téléchargez le modèle ici puis décompressez le fichier pour extraire le fichier yourdestination.md.
Vous trouverez ci-dessous des instructions sur l’utilisation du modèle pour créer votre page de documentation.
Étapes de création de votre page de destination steps-to-create-docs-page
Vous pouvez utiliser l’interface web GitHub ou votre environnement local pour créer la documentation de votre nouvelle destination dans Adobe Experience Platform. Recherchez des instructions pour les deux options dans les liens ci-dessous :
Bonnes pratiques best-practices
Consultez les bonnes pratiques de création avant et pendant la création de la page de documentation de destination. Veillez également à lire le guide de rédaction pour la documentation Adobe pour obtenir d’autres conseils de rédaction que l’équipe de documentation Adobe utilise lors de la création de documentation.