Documenting your service
Documenting your service includes providing details about how to use your product. And making sure that users can find these instructions by providing a link from the IBM Cloud catalog.
Creating your service documentation
As a third party, you must host and publish your service documentation.
It is recommended that you have a topic that covers deploying your service on IBM Cloud. Consider including this as part of a "Getting started" topic in your documentation. Don't redocument the user interface. Instead, guide your users where to start provisioning your service and cover any details that are not included in the UI text.
From there, make sure that the full use of your product is documented. And don't forget any self-help information like troubleshooting or FAQs. Also consider setting onboarding expectations, especially if your product onboarding is not automated from the console. For example, if onboarding is personalized or requires steps outside of IBM Cloud, outline that process for the user so that they know what to expect next.
Providing the Docs link
When a user clicks your service tile in the IBM Cloud catalog, the catalog details page appears for the user to learn more about your product. You want to make sure the Docs related link on the page is going to your service documentation.
To add the URL where you're hosting your service documentation, complete the following steps:
- In the IBM Cloud console, click the Navigation Menu icon
> Partner Center > My products and select your
product. - Click Catalog entry.
- Click Add your documentation URL.
- Enter the URL and click Save.