サービス文書の作成

サード・パーティーとして、サービス文書をホストして公開する必要があります。

IBM Cloudへのサービスのデプロイについて説明するトピックを用意することをお勧めします。 これを「始めに」トピックの一部として資料に含めることを検討してください。 ユーザー・インターフェースを再文書化しないでください。 代わりに、サービスのプロビジョニングをどこから始めればよいかをユーザーに案内し、UIのテキストに含まれていない詳細をカバーする。

そこから、製品の完全な使用法が文書化されていることを確認します。 また、トラブルシューティングや FAQ などのセルフヘルプ情報も忘れないでください。 また、特に製品のオンボーディングがコンソールから自動化されていない場合は、オンボーディングの期待値を設定することも検討してください。 例えば、オンボーディングが個別設定されている場合、または IBM Cloudの外部でステップを必要とする場合は、次に何が予期されるかをユーザーが認識できるように、そのプロセスの概要を示します。

「資料」 リンクの提供

ユーザーが IBM Cloud カタログ内のサービス・タイルをクリックすると、カタログの詳細ページが表示され、ユーザーが製品の詳細を確認できるようになります。 ページ上の 「資料」 関連リンクがサービス資料に移動していることを確認する必要があります。

サービス・ドキュメントをホスティングしている URL を追加するには、以下の手順を実行します：

1. IBM Cloud コンソールで、 「ナビゲーション・メニュー」 アイコン > パートナー・センター > 「マイ製品」 をクリックし、製品を選択します。
2. **「カタログ・エントリー」**をクリックします。
3. Add your documentation URL をクリックします。
4. URL を入力し、 セーブ をクリックする。