Uw bron documenteren
Gemaakt voor:
- Ontwikkelaar
De laatste stap voordat uw nieuwe bron live in Adobe Experience Platform kan worden ingesteld, is het documenteren van uw nieuwe bron.
Deze handleiding bevat:
- Een zelfstudie die u kunt volgen om een documentatiepagina voor uw nieuwe bron te maken;
- Een documentatiesjabloon dat u kunt invullen voor uw nieuwe bron.
- Instructies op hoe te om Markering voor het schrijven van technische documentatiete gebruiken;
- Instructies bij het begrip van de aroma van de Prijsverhoging van Adobe.
Vereisten
De volgende items zijn vereist voordat u de nieuwe bron kunt documenteren:
- Een geldige GitHub gebruikersrekening: Als u geen bestaande rekening GitHub hebt, dan moet u één door de GitHub ondertekenen paginatot stand brengen;
- Toegang tot Desktop GitHub: U moet de Desktop gebruiken GitHub appom uw brondocumentatie in uw lokaal milieu tot stand te brengen;
- Uw integratie met Adobe moet zich in een testfase bevinden en uw bron moet worden geïmplementeerd in een testomgeving in Experience Platform.
Instructies op hoog niveau voor het maken van documentatie voor uw bron in Experience Platform
Op hoog niveau moet u voor het maken van documentatie voor uw bron een vork maken in de Experience Platform-documentatieopslagplaats en de meegeleverde documentatiesjabloon bewerken in een nieuwe vertakking. Gebruik de door Adobe verschafte sjabloon om een nieuwe bronpagina te maken en een pull request (PR) te openen wanneer u klaar bent. Hieronder vindt u instructies voor het maken van de nieuwe bronpagina.
Documentatiesjabloon
U kunt een vooraf ingevuld documentatiemalplaatjegebruiken om in het creëren van documentatie voor uw bron bij te wonen. Hieronder vindt u instructies voor het bewerken van de sjabloon en het openen van een pull-verzoek. Verzonden documentatie voor uw nieuwe bron wordt gecontroleerd en gepubliceerd door het Adobe-documentatieteam.
U kunt ook de onderstaande documentatiesjablonen downloaden:
Nieuwe bronpagina maken
U kunt de GitHub Webinterface of uw lokaal milieu gebruiken om documentatie voor uw nieuwe bron in Experience Platform tot stand te brengen. Zoek instructies voor beide opties in de onderstaande koppelingen: