Best practice di authoring

Panoramica

Questa pagina descrive le regole da seguire quando creazione della documentazione di destinazione per garantire che soddisfi gli standard di qualità della documentazione di Adobe Experience Platform.

Indicazioni generali

  • Quando si riempie il template per la documentazione sulla destinazione, consulta la guida per i collaboratori di Adobe per informazioni collegamento, tabelle, sintassi markdown supportata, guida alla scritturae altro ancora.
  • Non includere osservazioni e stime nella documentazione del prodotto.
  • Nella documentazione di Experience Platform, gli autori di Adobe utilizzano formattazione grassetto per fare riferimento ai controlli dell’interfaccia utente, come riportato di seguito:
    • Vai a Connessioni > Destinazioni, quindi seleziona la Catalogo scheda . Visualizzare un esempio di come i controlli dell’interfaccia utente sono documentati in un esercitazione sulle destinazioni.

Collegamento

Segui il modello di documentazione fornito e non modificare i collegamenti esistenti nel modello. Quando includi nuovi collegamenti, leggi utilizzo dei collegamenti nella documentazione nella guida per i collaboratori.

Linee guida sul branding

  • AEP non è un termine approvato rivolto al pubblico. Utilizza Adobe Experience Platform al primo utilizzo, quindi Experience Platform, quindi Platform.
    • Non utilizzare: Prima di poter esportare i dati da AEP a YourDestination, assicurati di leggere e completare questi prerequisiti.
    • Utilizzo: Prima di esportare i dati da Adobe Experience Platform a YourDestination, verifica di aver letto e completato questi prerequisiti.

Immagini e schermate

  • Per informazioni su come collegare alle immagini, consulta la guida per i collaboratori .
  • Quando utilizzi le schermate, accertati che la schermata acquisisca l’intera schermata dell’interfaccia utente di Platform.
  • Quando contrassegni le immagini per evidenziare un determinato controllo o etichetta sulla pagina, prova a seguire lo stile di markup utilizzato dal team di documentazione di Experience Platform. Osserva come viene evidenziato in Basato su profilo questa schermata.
  • Utilizzare png formattare le immagini.
  • Non utilizzare schermate numerate come nomi di file. I nomi dei file immagine devono essere descrittivi.
    • Non utilizzare: 1.png, 2.png, 3.png
    • Utilizzare: yourdestination-authentication-details.png, yourdestination-destination-details.png
  • Utilizza il testo alt per tutte le immagini aggiunte alla documentazione e utilizza la grammatica appropriata nel testo alt.
    • Non utilizzare: Dettagli di connessione di destinazione
    • Utilizzo: Immagine dell’interfaccia utente di Platform, che mostra i dettagli della connessione di destinazione compilati.

Processo

  • La modello di documentazione viene aggiornato di rado in base al feedback del partner. Prima di iniziare a creare la documentazione per la destinazione, assicurati di aver scaricato il versione più recente del modello.
  • Crea la documentazione e crea la richiesta di pull della documentazione (PR) da un ramo del tuo fork diversa dalla filiale principale. Consulta la sezione invia destinazione per la revisione durante l’authoring in Interfaccia GitHub o ambiente locale.

In questa pagina