Overzicht van de documentatie van Experience Platforms
De documentatie van Adobe Experience Platform is beschikbaar voor een aantal eigenschappen en de diensten van het Platform. Ga als volgt te werk om de documentatie van het Experience Platform te openen: openingspagina van documentatie en selecteer de gids u wilt bekijken.
Typen documentatie van Experience Platforms
De documentatie van het Experience Platform wordt verstrekt in veelvoudige formaten, met inbegrip van overzichten, leerprogramma's, en gidsen voor zowel de gebruikersinterface (UI) als API. De meest gebruikelijke documentatietypen worden samengevat in de volgende lijst:
-
API-referentie: Raadpleeg de API-naslagdocumentatie voor elke service voor meer informatie over de beschikbare eindpunten, zoals kopteksten, parameters, voorbeeldaanvragen en antwoorden. Deze referentiematerialen zijn niet even gedetailleerd als de documentatie. Het wordt aanbevolen de servicespecifieke ontwikkelaarsgids te raadplegen voor gedetailleerde voorbeelden van API-gebruik.
-
Handleiding voor ontwikkelaars: Elke ontwikkelaarsgids verstrekt diepgaande gebruiksinformatie voor alle API eindpunten beschikbaar voor de specifieke dienst. De gids omvat beschikbare vraagparameters, steekproefverzoeken, en steekproefreacties, evenals het schetsen "gotchas"om te vermijden wanneer het maken van vraag aan Platform API's.
-
Overzicht: Een overzicht verstrekt een overzicht op hoog niveau van de dienst of de eigenschap en hoe het met andere interactie aangaat Platform diensten. Het overzicht is de beste plek om te beginnen wanneer u leert over nieuwe functies en functionaliteit binnen Platform.
-
Handleiding voor probleemoplossing: Gebruik de gids voor het oplossen van problemenoplossing om antwoorden op vaak gestelde vragen en informatie betreffende foutenmeldingen te vinden die u waarschijnlijk zult ontmoeten wanneer het gebruiken van API. De Experience Platform de het oplossen van problemengids verleent steun voor algemene vragen en fouten, terwijl de individuele diensten het oplossen van problemengidsen specifiek voor hun gebied verstrekken.
-
Zelfstudie: Een zelfstudie is een stapsgewijze handleiding via de UI, API of een combinatie van beide die tot een specifiek resultaat leidt. In tegenstelling tot een ontwikkelaarsgids, kan een API leerprogramma zich slechts op één of twee eindpunten concentreren en is geen volledige API middel. Op dezelfde manier kunnen de zelfstudies UI slechts op specifieke stappen, niet de volledige gebruikersinterface beschikbaar voor die dienst concentreren. Tutorials maken vaak deel uit van een grotere werkstroom en hebben de functie "volgende stappen" die beschrijven welke zelfstudies u wilt proberen volgende.
-
UI-gids: Een UI-hulplijn schetst acties die beschikbaar zijn in het dialoogvenster Platform gebruikersinterface voor een specifieke dienst. Deze documenten bevatten schermafbeeldingen en stappen die zijn gericht op interactie met Platform via de gebruikersinterface. Net als in een handleiding voor ontwikkelaars worden in de UI-handleiding alle beschikbare acties en opties beschreven, inclusief 'gotchas' die moeten worden vermeden. Dit is het meest gedetailleerde middel voor het werken met UI.