Saltar la navegación

8.2.- Guía de referencia.

Caso práctico

Juan le explica a Ana, que hay muchos tipos de manuales para el software. Por ejemplo, para poder implementar la aplicación, él tiene que consultar continuamente la guía de referencia Java.

—¿Pero no es lo mismo un manual de usuario que una guía de referencia? — pregunta Ana.

—No, son documentos distintos —responde Juan.

Imagen de Juan, uno de los protagonistas de nuestros casos prácticos.
Ministerio de Educación y Formación Profesional (Elaboración propia)



Una guía de referencia es un tipo de manual específico que, a diferencia de un manual de usuario, nos ofrece información detallada sobre las características y uso de una determinada aplicación. Las guías de referencia suelen estar destinadas a usuarios experimentados. En las guías de referencias suelen mostrar una lista completa de mensajes de error y como detectar y recuperarse ante los errores detectados.

Un ejemplo típico de manual de referencia, sería la guía de referencia para la utilización de un entorno de desarrollo, donde es posible programar en diferentes lenguajes de programación. Para que el usuario pueda utilizar esta aplicación, el manual de usuario le va a indicar los pasos necesarios para crear un nuevo proyecto, como navegar por las diferentes ventanas de la aplicación, las distintas opciones que presenta el menú, junto con su utilidad. Una guía de referencia, en este caso, sería el manual donde se detalla la sintaxis, palabras reservadas, tipos de sentencias, etc, específicos del lenguaje de programación con el que vayamos a trabajar, por ejemplo: Java.

El uso más extendido de las guías de referencia, es en aquellas aplicaciones que requieren un conocimiento muy especializado sobre una lista de comandos o de un lenguaje de programación. Por ejemplo, cuando se trabaja con entornos de desarrollo, o se trabaja con aplicaciones que permitan la ejecución de comandos a través de una consola, es muy común que junto al manual de usuario se distribuya una guía de referencia. En esta guía de referencia se incorpora la información técnica y detallada de los comandos (junto con sus opciones) que se pueden utilizar en la aplicación, o si se trata de un entorno de desarrollo, la guía de referencia presentará: la sintaxis, palabras reservadas, tipos de instrucciones, etc, de ese lenguaje de programación.

Autoevaluación

Pregunta

¿Qué documento aporta información muy especializada, estando dirigido a usuarias y usuarios con conocimientos avanzados?

Respuestas

Manual de usuario.

Guía rápida.

Guía de referencia.

Retroalimentación