Sistema de ayuda en línea para PaaSOS

Una de las últimas cosas que hay que rematar en un buen proyecto de software es la documentación de usuario del producto. También es necesario que el usuario de PaaSOS disponga de esta ayuda de una forma actualizada, contextual e inmediata.

A nosotros después de trabajar bastante sobre ello (https://tipesoft.com/servicios-web-fcilmente-accesibles-en-velneo/) se nos ocurrió una solución imaginativa que resuelve casi toda la problemática.

Por un lado publicar toda la documentación de forma ordenada en WordPress, por otro facilitar el acceso a esta documentación mediante el formato estándar json y por último conectar v7 con este formato.

La idea es unir tres tecnologías wordpress+json+velneov7

El resultado es esperanzador, podéis disponer de un botón de ayuda donde lo deseéis y que os muestre lo que realmente necesita el usuario con muy poco esfuerzo.

El complemento que hemos utilizado en wordpress para facilitar toda la integración es JSON API http://wordpress.org/extend/plugins/json-api/. Básicamente permite acceder a toda la información publicada en wordpress mediante json.

Como os podéis imaginar en PaaSOS estamos implementando esta solución y estará disponible en breve (cuando toda la documentación sea pública).

Botón de ayuda contextual

Intérnamente, cuando pulsamos en el botón de ayuda nos conectamos a la página o páginas de wordpress necesarias, descargamos el contenido y mediante scripts de Velneo lo evaluamos. Por último componemos la página de ayuda y la cacheamos para que la próxima vez no sea necesaria la descarga.

Ayuda mostrada en pantalla (una sola página como fuente)

Un ejemplo algo más avanzado es cuando tenemos que mostrar un índice con varias páginas.

Formulario de ayuda multi-página (múltiples entradas conforman la ayuda)

Lo cierto es que esta solución es muy válida. Estaría muy bien que todos utilizásemos estas mismas técnicas para componer nuestras ayudas.

Lo ideal sería que Velneo facilitase el acceso a toda la documentación de v7 mediante json podríamos vincular nuestras ayudas a la documentación en línea de Velneo de forma sencilla.

Descargar en formato PDFDescargar en PDF
1 estrella2 estrellas3 estrellas4 estrellas5 estrellas (2 votes, average: 4,00 out of 5)
Cargando…

Seguir Jorge Hontoria Jimenez:

Gerente de TipeSoft

Dirección de proyectos de integración de software y aplicaciones orientadas a servicios. Implantación de soluciones de integración basadas en SharePoint Portal.

Últimas publicaciones de

Dejar una opinión