Documentation de votre service

Pour documenter votre service, vous devez fournir des détails sur la manière d'utiliser votre produit et vous assurer que les utilisateurs peuvent trouver ces instructions en fournissant un lien à partir du catalogue IBM Cloud.

Création de la documentation de votre service

En tant que tiers, vous devez héberger et publier votre documentation de service.

Il est recommandé de disposer d'une rubrique traitant du déploiement de votre service sur IBM Cloud. Envisagez d'inclure ce point dans la rubrique "Initiation" de votre documentation. Ne redocumentez pas l'interface utilisateur. Au lieu de cela, guidez vos utilisateurs pour qu'ils sachent où commencer le provisionnement de votre service et couvrez tous les détails qui ne sont pas inclus dans le texte de l'interface utilisateur.

A partir de là, assurez-vous que l'utilisation complète de votre produit est documentée. Et n'oubliez pas les informations d'auto-assistance telles que le traitement des incidents ou les foires aux questions. Pensez également à définir les attentes d'intégration, en particulier si l'intégration de votre produit n'est pas automatisée à partir de la console. Par exemple, si l'intégration est personnalisée ou nécessite des étapes en dehors de IBM Cloud, décrivez ce processus pour l'utilisateur afin qu'il sache à quoi s'attendre ensuite.