Saltar la navegación

8.- Tipo de manuales.

Caso práctico

En BK tienen especial interés en crear una buena documentación de sus aplicaciones. Para la aplicación de Gestión Hotelera, han decidido crear un manual de usuario y una guía rápida.

Ana le pregunta a Juan qué diferencia hay entre una guía rápida y un manual de usuario. Juan responde que hay distintos tipos de manuales, cada uno con sus funciones y destinatarios concretos.

Imagen de Ana, mujer joven, de pie, con camisa azul y mirando de frente.
Ministerio de Educación y Formación Profesional (Elaboración propia)



Ilustración de un conjunto de manuales de diferentes lenguajes de programación y aplicaciones.
INTEF (BY-NC-SA)



Durante el desarrollo de una aplicación informática, las desarrolladoras o desarrolladores, que la están implementando, generan una documentación del código que se crea, con el objeto de facilitar el mantenimiento de la aplicación y corrección de posibles errores que se produzcan durante el desarrollo y uso del sistema desarrollado. Sin embargo, en la mayoría de los casos, los usuarios o usuarias finales de la aplicación, van a ser distintos a los desarrolladores y desarrolladoras de la aplicación, y posiblemente desconozcan por completo el código de la aplicación que utilizan.

Para facilitar el uso de la aplicación que se crea, es necesario que como parte del proyecto se generen documentos, tanto en formato electrónico como impresos en papel, que permitan a los usuarios y usuarias finales de la aplicación su instalación, configuración, uso, mantenimiento, actualización y eliminación en su caso. Estos documentos que se incorporan a las aplicaciones son los manuales.

En la actualidad, se tiende a prescindir de manuales impresos en papel, distribuyéndose en formato electrónico, y pudiendo descargarlos desde los sitios Web de los desarrolladores del software.

Entre los tipos de manuales más habituales que nos encontramos, aparecen los siguientes:

  • Manual de usuario.
  • Guía de referencia.
  • Guías rápidas.
  • Manuales de instalación.

Autoevaluación

Pregunta

¿La herramienta de JavaHelp que genera la base de datos de búsquedas es?

Respuestas

jhindexer.

jhsearch.

hsviewer.

TOC.xml.

Retroalimentación