Documentazione del tuo servizio
La documentazione del servizio comprende la fornitura di dettagli su come utilizzare il prodotto e la garanzia che gli utenti possano trovare queste istruzioni fornendo un link dal catalogo IBM Cloud.
Creazione della documentazione del servizio
Come terze parti, è necessario ospitare e pubblicare la documentazione del servizio.
Ti consigliamo di disporre di un argomento che copre la distribuzione del tuo servizio su IBM Cloud. Includi questo argomento come parte di un argomento "Introduzione" nella tua documentazione. Non documentare nuovamente l'interfaccia utente. Guidate invece gli utenti su come iniziare il provisioning del servizio e coprite tutti i dettagli che non sono inclusi nel testo dell'interfaccia utente.
Da lì, assicurarsi che l'uso completo del prodotto sia documentato. E non dimenticare le informazioni di auto - aiuto come la risoluzione dei problemi o FAQ. Considerare anche l'impostazione delle aspettative di onboarding, soprattutto se l'onboarding del prodotto non è automatizzato dalla console. Ad esempio, se l'onboarding è personalizzato o richiede passi esterni a IBM Cloud, delineare tale processo per l'utente in modo che sappia cosa aspettarsi in seguito.
Fornitura del link Docs
Quando un utente fa clic sul tuo tile del servizio nel catalogo IBM Cloud, viene visualizzata la pagina dei dettagli del catalogo per l'utente per ulteriori informazioni sul tuo prodotto. Vuoi assicurarti che il link correlato a Docs nella pagina stia andando alla documentazione del servizio.
Per aggiungere il sito URL in cui è ospitata la documentazione del servizio, completare i passaggi seguenti:
- Nella console IBM Cloud, fare clic sull'icona Menu di navigazione
> Partner Center > Prodotti personali e selezionare il proprio prodotto. - Fare clic su Voce di catalogo.
- Fare clic su Aggiungi la tua documentazione URL.
- Immettere il sito URL e fare clic su Salva.