서비스 문서화
서비스 문서화에는 제품 사용 방법에 대한 세부 정보를 제공하고 IBM Cloud 카탈로그의 링크를 제공하여 사용자가 이러한 지침을 찾을 수 있도록 하는 것이 포함됩니다.
서비스 문서 작성
써드파티로서 서비스 문서를 호스트하고 공개해야 합니다.
IBM Cloud에 서비스 배치를 다루는 주제가 있는 것이 좋습니다. 문서에서 "시작하기" 주제의 일부로 이를 포함하는 것을 고려하십시오. 사용자 인터페이스를 다시 문서화하지 마십시오. 대신 사용자에게 서비스 프로비저닝을 시작할 수 있는 위치를 안내하고 UI 텍스트에 포함되지 않은 세부 사항을 다루세요.
여기에서 제품의 전체 사용이 문서화되어 있는지 확인하십시오. 또한 문제점 해결 또는 FAQ와 같은 자체 도움말 정보를 잊지 마십시오. 또한 특히 콘솔에서 제품 온보딩이 자동화되지 않은 경우에는 온보딩 기대치를 설정하는 것을 고려하십시오. 예를 들어, 온보딩이 개인화되었거나 IBM Cloud외부의 단계를 필요로 하는 경우 다음에 예상되는 사항을 알 수 있도록 사용자에 대한 해당 프로세스의 아웃라인을 작성하십시오.
Docs 링크 제공
사용자가 IBM Cloud 카탈로그에서 서비스 타일을 클릭하면 사용자가 제품에 대해 자세히 학습할 수 있도록 카탈로그 세부사항 페이지가 표시됩니다. 페이지의 Docs 관련 링크가 서비스 문서로 이동하는지 확인하려고 합니다.
서비스 문서를 호스팅하는 곳에 URL 을 추가하려면 다음 단계를 완료하세요:
- IBM Cloud 콘솔에서 탐색 메뉴 아이콘
> Partner Center > 내 제품 을 클릭하고 제품을 선택하십시오.
- 카탈로그 항목을 클릭하십시오.
- 문서 추가 URL 를 클릭합니다.
- URL 을 입력하고 저장을 클릭합니다.