Documentare la destinazione in Adobe Experience Platform

Panoramica

Benvenuto in Adobe Experience Platform, grande per averti qui!
Documentare la destinazione è l'ultimo passaggio prima che possa essere impostata in tempo reale in Adobe Experience Platform.

Questa sezione della documentazione include:

• Istruzioni dettagliate per creare una pagina di documentazione per la nuova destinazione;
• Un modello da compilare per la destinazione;
• Istruzioni generali sull’utilizzo di Markdown;
• Istruzioni specifiche per l’Adobe Markdown (il sapore Adobe Markdown è molto simile al normale Markdown).
• A pagina delle best practice per facilitare la creazione di una pagina di documentazione per la pagina di destinazione, che soddisfi gli standard Experienci Platform di qualità della documentazione.

Prerequisiti

Per creare la documentazione per la destinazione in base alle istruzioni contenute in questo articolo, sono necessari i seguenti elementi:

• Un account GitHub. Iscriviti a GitHub se non avete ancora un account.
• Desktop GitHub. Se selezioni creare la documentazione nell’ambiente locale, è necessario utilizzare Desktop GitHub.
• L'integrazione con Adobe deve trovarsi in una fase di test con la destinazione distribuita in un ambiente di staging in Adobe Experience Platform.

Istruzioni di alto livello per creare la documentazione per la destinazione in Adobe Experience Platform

Ad un livello elevato, per creare la documentazione per la tua destinazione, devi creare un fork dell’archivio della documentazione di Adobe Experience Platform e modifica il modello di documentazione fornito in un nuovo ramo. Utilizza il modello fornito dall’Adobe per creare una nuova pagina di destinazione. Apri una richiesta di pull (PR) quando sei pronto. Le istruzioni per eseguire questa operazione sono più avanti, in Passaggi per creare la nuova pagina di destinazione.

Modello di documentazione

Per aiutarti a creare la pagina della documentazione, Adobe ha precompilato un modello di documentazione per te. Di seguito, trovi istruzioni su come modificare il modello e aprire una richiesta di pull. Il team di documentazione di Adobe esaminerà e pubblicherà la documentazione per la nuova destinazione.

Scarica il modello qui e decomprimi il file per estrarre il yourdestination.md file.

Di seguito sono riportate ulteriori istruzioni sull’utilizzo del modello per creare la pagina della documentazione.

Passaggi per creare la nuova pagina di destinazione

Puoi utilizzare l’interfaccia web GitHub o l’ambiente locale per creare la documentazione per la nuova destinazione in Adobe Experience Platform. Trova le istruzioni per entrambe le opzioni nei collegamenti seguenti:

• Utilizza l’interfaccia web GitHub per creare una pagina di documentazione di destinazione
• Utilizza un editor di testo nel tuo ambiente locale per creare una pagina di documentazione di destinazione

Best practice

Consulta la sezione best practice di authoring prima e durante la creazione della pagina della documentazione di destinazione. Assicurati anche di leggere il guida alla scrittura per la documentazione di Adobe per ulteriori suggerimenti per la scrittura utilizzati dal team di documentazione di Adobe durante l’authoring della documentazione.