Documentación del servicio
Documentar su servicio incluye proporcionar detalles sobre cómo utilizar su producto y asegurarse de que los usuarios puedan encontrar estas instrucciones proporcionando un enlace desde el catálogo IBM Cloud.
Creación de la documentación de servicio
Como tercero, debe alojar y publicar la documentación de servicio.
Se recomienda que tenga un tema que cubra el despliegue del servicio en IBM Cloud. Considere la posibilidad de incluirlo como parte de un tema "Cómo empezar" en la documentación. No vuelva a documentar la interfaz de usuario. En su lugar, guíe a sus usuarios sobre dónde empezar a aprovisionar su servicio y cubra cualquier detalle que no esté incluido en el texto de la interfaz de usuario.
A partir de ahí, asegúrese de que el uso completo de su producto está documentado. Y no olvides ninguna información de autoayuda como la resolución de problemas o las preguntas frecuentes. Considere también establecer las expectativas de incorporación, especialmente si la incorporación del producto no está automatizada desde la consola. Por ejemplo, si la incorporación está personalizada o requiere pasos fuera de IBM Cloud, describa el proceso para el usuario de forma que sepa qué esperar a continuación.
Proporcionar el enlace Documentos
Cuando un usuario pulsa el mosaico del servicio en el catálogo IBM Cloud, aparece la página de detalles del catálogo para que el usuario obtenga más información sobre el producto. Desea asegurarse de que el enlace relacionado Documentos de la página va a la documentación del servicio.
Para añadir la dirección URL en la que aloja la documentación del servicio, siga estos pasos:
- En la consola de IBM Cloud, pulse el icono Menú de navegación
> Partner Center > Mis productos y seleccione
el producto. - Pulse Entrada de catálogo.
- Haga clic en Añada su documentación URL.
- Introduzca la dirección URL y haga clic en Guardar.