Documentare la destinazione in Adobe Experience Platform
Panoramica overview
Benvenuto in Adobe Experience Platform, grande per averti qui!
La documentazione della destinazione è il passaggio finale prima di poterla impostare live 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 il gusto Markdown Adobe (il gusto Markdown Adobe è molto simile al normale Markdown).
- Una pagina delle best practice per aiutarti a creare una pagina di documentazione per la pagina di destinazione che soddisfi gli standard di qualità della documentazione di Experience Platform.
Prerequisiti prerequisites
Per creare la documentazione per la destinazione in base alle istruzioni riportate in questo articolo, sono necessari i seguenti elementi:
- Un account GitHub. Registrati a GitHub se non hai ancora un account.
- Desktop GitHub. Se si sceglie di creare la documentazione nell'ambiente locale, è necessario utilizzare GitHub Desktop.
- L’integrazione con Adobe deve essere in una fase di test con la destinazione implementata in un ambiente di staging in Adobe Experience Platform.
Istruzioni di alto livello per creare la documentazione per la destinazione in Adobe Experience Platform high-level-instructions
Ad alto livello, per creare la documentazione per la destinazione, devi creare un fork dell'archivio della documentazione di Adobe Experience Platform e modificare 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 riportate di seguito, in Passaggi per creare la nuova pagina di destinazione.
Modello di documentazione documentation-template
Per facilitare la creazione della pagina della documentazione, Adobe ha precompilato un modello di documentazione per te. Più avanti, puoi trovare le istruzioni per modificare il modello e aprire una richiesta di pull. Il team della documentazione di Adobe esaminerà e pubblicherà la documentazione per la nuova destinazione.
Scarica il modello qui e decomprimi il file per estrarre il file yourdestination.md.
Le istruzioni sull’utilizzo del modello per creare la pagina della documentazione sono riportate di seguito.
Passaggi per creare la nuova pagina di destinazione steps-to-create-docs-page
Puoi utilizzare l’interfaccia web GitHub o l’ambiente locale per creare la documentazione per la nuova destinazione in Adobe Experience Platform. Per istruzioni su entrambe le opzioni, consulta i collegamenti seguenti:
Best practice best-practices
Rivedi le best practice per l'authoring prima e durante la creazione della pagina della documentazione di destinazione. Assicurati anche di leggere le istruzioni per la scrittura per la documentazione di Adobe per altri suggerimenti per la scrittura utilizzati dal team della documentazione di Adobe durante l'authoring della documentazione.