Dokumentieren des Ziels in Adobe Experience Platform
Übersicht overview
Willkommen in Adobe Experience Platform, ein tolles Angebot für Sie!
Die Dokumentation Ihres Ziels ist der letzte Schritt, bevor es in Adobe Experience Platform live gesetzt werden kann.
Dieser Dokumentationsabschnitt umfasst:
- Schrittweise Anleitungen 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 den Adobe Markdown-Geschmack (der Adobe Markdown-Geschmack ähnelt dem regulären Markdown-Geschmack).
- Eine Best Practices-Seite, die Sie beim Erstellen einer Dokumentationsseite für Ihre Zielseite unterstützt, die den Qualitätsstandards der Experience Platform-Dokumentation entspricht.
Voraussetzungen prerequisites
Um die Dokumentation für Ihr Ziel gemäß den Anweisungen in diesem Artikel zu erstellen, sind die folgenden Elemente erforderlich:
- Ein GitHub-Konto. Registrieren Sie sich für GitHub , wenn Sie noch kein Konto haben.
- GitHub-Desktop. Wenn Sie die Option Erstellen der Dokumentation in Ihrer lokalen Umgebung auswählen, müssen Sie GitHub Desktop verwenden.
- Ihre Integration mit Adobe muss sich in einer Testphase befinden, während 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 auf hoher Ebene eine Abspaltung des Adobe Experience Platform-Dokumentations-Repositorys erstellen und die bereitgestellte Dokumentationsvorlage in einer neuen Verzweigung bearbeiten. Verwenden Sie die vom Adobe bereitgestellte Vorlage, um eine neue Zielseite zu erstellen. Öffnen Sie eine Pull-Anforderung (PA), 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 vorausgefüllt. Weiter unten finden Sie Anweisungen zum Bearbeiten der Vorlage und Öffnen einer Pull-Anforderung. Das Adobe-Dokumentationsteam prüft und veröffentlicht die Dokumentation für Ihr neues Ziel.
Laden Sie die Vorlage hier herunter und dekomprimieren 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 Ihrer neuen Zielseite steps-to-create-docs-page
Sie können die GitHub-Webschnittstelle oder Ihre lokale Umgebung verwenden, um eine Dokumentation für Ihr neues Ziel in Adobe Experience Platform zu erstellen. Anweisungen für beide Optionen finden Sie unter den folgenden Links:
Best Practices best-practices
Lesen Sie die Best Practices für die Bearbeitung , bevor und während Sie die Zieldokumentationsseite erstellen. Lesen Sie auch die Schreibanleitung für die Adobe-Dokumentation , um mehr Tipps zu erhalten, die das Adobe-Dokumentationsteam beim Erstellen von Dokumentationen verwendet.