Servicedokumentation erstellen

Als Drittanbieter müssen Sie Ihre Servicedokumentation hosten und veröffentlichen.

Es wird empfohlen, dass Sie einen Abschnitt haben, der die Bereitstellung Ihres Service auf IBM Cloudbehandelt. Ziehen Sie in Betracht, dies als Teil eines Abschnitts "Erste Schritte" in Ihrer Dokumentation einzuschließen. Dokumentieren Sie die Benutzerschnittstelle nicht erneut. Führen Sie Ihre Benutzer stattdessen an, wo sie mit der Bereitstellung Ihres Dienstes beginnen können, und erläutern Sie alle Details, die nicht im Text der Benutzeroberfläche enthalten sind.

Stellen Sie von dort aus sicher, dass die vollständige Nutzung Ihres Produkts dokumentiert ist. Und vergessen Sie keine Informationen zur Selbsthilfe wie Fehlerbehebung oder FAQs. Ziehen Sie auch die Festlegung von Onboarding-Erwartungen in Betracht, insbesondere wenn Ihr Produkt-Onboarding nicht über die Konsole automatisiert wird. Wenn das Onboarding beispielsweise personalisiert ist oder Schritte außerhalb von IBM Clouderfordert, skizzieren Sie diesen Prozess für den Benutzer, damit er weiß, was als Nächstes erwartet wird.

Link Docs bereitstellen

Wenn ein Benutzer im IBM Cloud-Katalog auf Ihre Servicekachel klickt, wird die Seite mit den Katalogdetails angezeigt, auf der der Benutzer weitere Informationen zu Ihrem Produkt erhalten kann. Sie möchten sicherstellen, dass der zugehörige Link Docs auf der Seite zu Ihrer Servicedokumentation führt.

Führen Sie die folgenden Schritte aus, um die URL hinzuzufügen, auf der Sie Ihre Dienstdokumentation hosten:

1. Klicken Sie in der IBM Cloud-Konsole auf das Symbol Navigationsmenü > Partner Center > Meine Produkte und wählen Sie Ihr Produkt aus.
2. Klicken Sie auf Katalogeintrag.
3. Klicken Sie auf Ihre Dokumentation hinzufügen URL.
4. Geben Sie die Adresse URL ein und klicken Sie auf Speichern.