Bästa tillvägagångssätt
Översikt overview
Den här sidan beskriver regler som du bör följa när du redigerar sidan för måldokumentation🔗, för att se till att den uppfyller kvalitetsstandarderna för Adobe Experience Platform-dokumentation.
Allmän vägledning general-guidance
- När du fyller i mallen för måldokumentationen läser du i handboken för Adobe Contributor om du vill ha information om länkning, tabeller, den kodningssyntax som stöds, skrivande vägledning med mera.
- Ta inte med observationer och uppskattningar i produktdokumentationen.
- I Experience Platform-dokumentationen använder Adobe-skrivare fet formatering för att referera till gränssnittskontroller, enligt följande:
- Gå till Connections > Destinations och välj fliken Catalog. Visa ett exempel på hur användargränssnittskontroller dokumenteras i en målsjälvstudiekurs.
Skrivstil
- Håll dina meningar korta och kom till saken snabbt. Om din mening är längre än 20 ord eller använder flera kommatecken kan du dela upp den i olika meningar. Meningar som är längre än 20 ord kan vara särskilt komplicerade för läsarna.
- Var inte överdrivet artig. Undvik att använda"snälla" eller"snälla" …" i den tekniska dokumentationen.
Länkning linking
Följ den angivna dokumentationsmallen och redigera inte de befintliga länkarna i mallen. När du inkluderar nya länkar kan du läsa med hjälp av länkar i dokumentation i handboken för deltagare.
Riktlinjer för varumärken branding
-
AEP är inte en godkänd offentlig term. Använd Adobe Experience Platform först, sedan Experience Platform och sedan Platform.
- Använd inte: Innan du kan exportera data från AEP till YourDestination bör du kontrollera att du läser och slutför dessa krav.
- Använd: Innan du kan exportera data från Adobe Experience Platform till din destination måste du läsa och slutföra dessa krav.
Bilder och skärmbilder images-and-screenshots
-
Mer information om hur du länkar till bilder finns i handboken för medverkande.
-
När du använder skärmbilder måste du se till att skärmbilden fångar upp hela användargränssnittsskärmen för plattformen.
-
När du markerar bilder för att markera en viss kontroll eller etikett på sidan, ska du följa den markeringsstil som används av dokumentationsteamet på Experience Platform. Observera hur Profilbaserad markeras i den här skärmbilden.
-
Använd
png-formatbilder. -
Använd inte numrerade skärmbilder som filnamn. Bildfilnamn ska vara beskrivande.
- Använd inte:
1.png,2.png,3.png - Använd:
yourdestination-authentication-details.png,yourdestination-destination-details.png
- Använd inte:
-
Använd alternativ text för alla bilder som du lägger till i dokumentationen och använd rätt grammatik i alternativ text.
- Använd inte: Information om målanslutning
- Använd: Bild av plattformsgränssnittet, med information om målanslutning ifylld.
Process process
- dokumentationsmallen uppdateras sällan, baserat på feedback från partner. Innan du börjar skapa dokumentation för ditt mål måste du kontrollera att du har hämtat den senaste versionen av mallen.
- Skriv dokumentationen och skapa en begäran om hämtning av dokumentation (PR) från en gren i din förgrening förutom huvudgrenen. Gå till Skicka-målet för granskning när du redigerar i GitHub-gränssnittet eller i din lokala miljö.