Uw doel documenteren in Adobe Experience Platform
Overzicht overview
Welkom bij Adobe Experience Platform, geweldig om je hier te hebben!
Het documenteren van uw bestemming is de laatste stap voordat deze live kan worden ingesteld in Adobe Experience Platform.
Deze sectie van documentatie omvat:
- Stapsgewijze instructies voor u om een documentatiepagina voor uw nieuwe bestemming tot stand te brengen;
- Een sjabloon dat u moet invullen voor uw doel.
- Algemene instructies voor het gebruik van Markdown;
- Specifieke aanwijzingen voor de Adobe Markdown-aroma (De Adobe Markdown-smaak lijkt sterk op de gewone Markdown-methode).
- A pagina met aanbevolen procedures om u te helpen een documentatiepagina voor uw bestemmingspagina opstellen, die aan de normen van de documentatiekwaliteit van het Experience Platform voldoet.
Vereisten prerequisites
Om documentatie voor uw bestemming volgens de instructies in dit artikel tot stand te brengen, zijn de volgende punten noodzakelijk:
- Een GitHub-account. Aanmelden voor GitHub als je nog geen account hebt.
- GitHub Desktop. Als u de documentatie in uw lokale omgeving makenmoet u GitHub Desktop.
- Uw integratie met Adobe moet zich in een testfase bevinden en uw bestemming moet worden geïmplementeerd in een testomgeving in Adobe Experience Platform.
Instructies op hoog niveau voor het maken van documentatie voor uw bestemming in Adobe Experience Platform high-level-instructions
Op hoog niveau, om documentatie voor uw bestemming te creëren, moet u een vork maken van de Adobe Experience Platform-documentatieopslagplaats en bewerk de meegeleverde documentatiesjabloon in een nieuwe vertakking. Gebruik het Adobe-Verstrekte malplaatje om een nieuwe bestemmingspagina tot stand te brengen. Open een trekkingsverzoek (PR) wanneer u klaar bent. Hieronder vindt u de instructies voor het gebruik van dit geneesmiddel, zoals beschreven in Stappen om uw nieuwe bestemmingspagina te creëren.
Documentatiesjabloon documentation-template
Om u te helpen bij het maken van uw documentatiepagina, heeft de Adobe een documentatiesjabloon voor jou. Hieronder vindt u instructies voor het bewerken van de sjabloon en het openen van een pull-verzoek. Het documentatieteam van de Adobe zal de documentatie voor uw nieuwe bestemming herzien en publiceren.
Download de sjabloon hier en decomprimeer het bestand om het uit te pakken yourdestination.md bestand.
Hieronder vindt u instructies over het gebruik van de sjabloon voor het maken van de documentatiepagina.
Stappen om uw nieuwe bestemmingspagina te creëren steps-to-create-docs-page
U kunt de het Webinterface van GitHub of uw lokaal milieu gebruiken om documentatie voor uw nieuwe bestemming in Adobe Experience Platform tot stand te brengen. Zoek instructies voor beide opties in de onderstaande koppelingen:
Best practices best-practices
Controleer de best practices ontwerpen voor en terwijl u de pagina van de bestemmingsdocumentatie creeert. Zorg ervoor dat u ook de schriftelijke richtsnoeren voor Adobe Documentatie voor wat meer het schrijven uiteinden die het de documentatieteam van de Adobe wanneer het ontwerpen van documentatie gebruikt.