Documenter votre destination dans Adobe Experience Platform
Vue d’ensemble overview
Bienvenue à Adobe Experience Platform, super de vous avoir ici !
La documentation de votre destination est la dernière étape avant qu’elle ne puisse être définie dans Adobe Experience Platform.
Cette section de documentation comprend :
- Cette section contient des instructions détaillées pour vous permettre de 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 saveur Adobe Markdown (la saveur Adobe Markdown est très similaire à Markdown standard).
- Une page de bonnes pratiques pour vous aider à créer une page de documentation pour votre page de destination, qui respecte les normes de qualité de la documentation Experience Platform.
Conditions préalables prerequisites
Pour créer la documentation de votre destination conformément aux instructions de cet article, les éléments suivants sont nécessaires :
- Compte GitHub. Inscrivez-vous à GitHub si vous n’avez pas encore de compte.
- GitHub Desktop. Si vous choisissez de créer la documentation dans votre environnement local, vous devez utiliser GitHub Desktop.
- Votre intégration à Adobe doit être dans une phase de test avec votre destination déployée dans un environnement d’évaluation dans Adobe Experience Platform.
Instructions de haut niveau pour créer de la documentation pour votre destination dans Adobe Experience Platform high-level-instructions
À un niveau élevé, pour créer de la documentation pour votre destination, vous devez créer un double 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 l’Adobe pour créer une page de destination. Ouvrez une requête de tirage (PR) lorsque vous êtes prêt. Les instructions pour ce faire sont décrites plus loin dans la section Procédure de création de votre nouvelle 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 pour vous. Vous trouverez ci-dessous des instructions pour modifier le modèle et ouvrir une requête d’extraction. L’équipe de documentation de l’Adobe examinera et publiera la documentation relative à votre nouvelle destination.
Téléchargez le modèle ici et 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.
Procédure de création d’une page de destination steps-to-create-docs-page
Vous pouvez utiliser l’interface web GitHub ou votre environnement local pour créer de la documentation pour votre nouvelle destination dans Adobe Experience Platform. Recherchez des instructions pour les deux options dans les liens ci-dessous :
Bonnes pratiques best-practices
Passez en revue les bonnes pratiques de création avant et pendant que vous créez la page de documentation de destination. Veillez également à lire les conseils d’écriture pour la documentation d’Adobe pour obtenir des conseils d’écriture que l’équipe de documentation d’Adobe utilise lors de la création de la documentation.