Dokumentieren des Ziels in Adobe Experience Platform
Übersicht overview
Willkommen in Adobe Experience Platform, schön, Sie hier zu haben!
Die Dokumentation Ihres Ziels ist der letzte Schritt, bevor es in Adobe Experience Platform live geschaltet werden kann.
Dieser Dokumentationsabschnitt enthält:
- Schrittweise Anweisungen zum Erstellen einer Dokumentationsseite für Ihr neues Ziel.
- Eine Vorlage, die Sie für Ihr Ziel ausfüllen können;
- Allgemeine Anweisungen zur Verwendung von Markdown;
- Spezifische Anweisungen für das Adobe-Markdown- (das Adobe-Markdown-Format ist dem normalen Markdown sehr ähnlich).
- Eine Best Practices-Seite die Ihnen beim Erstellen einer Dokumentationsseite für Ihre Zielseite hilft, die den Qualitätsstandards der Experience Platform-Dokumentation entspricht.
Voraussetzungen prerequisites
Um eine Dokumentation für Ihr Ziel gemäß den Anweisungen in diesem Artikel zu erstellen, sind die folgenden Elemente erforderlich:
- Ein GitHub-. Melden Sie sich für GitHub an, wenn Sie noch kein Konto haben.
- GitHub-Desktop. Wenn Sie sich für Erstellen der Dokumentation in Ihrer lokalen Umgebung entscheiden, müssen Sie GitHub Desktop verwenden.
- Ihre Integration mit Adobe muss sich in einer Testphase befinden, wobei Ihr Ziel in einer Staging-Umgebung in Adobe Experience Platform bereitgestellt wird.
Allgemeine Anweisungen zum Erstellen der Dokumentation für Ihr Ziel in Adobe Experience Platform high-level-instructions
Um eine Dokumentation für Ihr Ziel zu erstellen, müssen Sie eine Abspaltung erstellen des Adobe Experience Platform-Dokumentations-Repositorys und die bereitgestellte Dokumentationsvorlage in einer neuen Verzweigung bearbeiten. Verwenden Sie die von der Adobe bereitgestellte Vorlage, um eine neue Zielseite zu erstellen. Öffnen Sie eine Pull-Anfrage (PR), wenn Sie bereit sind. Anweisungen dazu finden Sie weiter unten unter Schritte zum Erstellen Ihrer neuen Zielseite.
Dokumentationsvorlage documentation-template
Um Sie bei der Erstellung Ihrer Dokumentationsseite zu unterstützen, hat Adobe eine Dokumentationsvorlage für Sie vorbefüllt. Weiter unten finden Sie Anweisungen, wie Sie die Vorlage bearbeiten und eine Pull-Anfrage öffnen. Das Adobe-Dokumentations-Team überprüft und veröffentlicht die Dokumentation für Ihr neues Ziel.
Laden Sie hier die Vorlage herunter und entpacken Sie die Datei, um die yourdestination.md
-Datei zu extrahieren.
Anweisungen zur Verwendung der Vorlage zum Erstellen Ihrer Dokumentationsseite finden Sie weiter unten.
Schritte zum Erstellen der neuen Zielseite steps-to-create-docs-page
Sie können die GitHub-Web-Benutzeroberfläche oder Ihre lokale Umgebung verwenden, um Dokumentation für Ihr neues Ziel in Adobe Experience Platform zu erstellen. Anweisungen für beide Optionen finden Sie in den folgenden Links:
Best Practices best-practices
Lesen Sie die Best Practices zum Authoring, bevor und während Sie die Zieldokumentationsseite erstellen. Lesen Sie auch die Schreibanleitung für die Adobe-Dokumentation, um einige weitere Tipps zu erhalten, die das Adobe-Dokumentations-Team beim Verfassen der Dokumentation verwendet.