Al desarrollar una aplicación informática, uno de los elementos que se deben implementar son los ficheros de ayuda. Un fichero de ayuda nos permite conocer las características y forma de trabajo de una aplicación. Sirven de guía, de referencia, manual a los diferentes usuarios y usuarias de una aplicación.

El fichero de ayuda nos permite acceder a información sobre la instalación, configuración, utilización y administración de un programa informático. En la mayoría de los casos, los ficheros de ayuda sirven de asistencia al usuario o usuaria de la aplicación.

Los ficheros de ayuda se implementan en diferentes formatos, en función de la plataforma donde se distribuya el software, el lenguaje de programación utilizado o el entorno de desarrollo. En general, la mayoría de los ficheros de ayuda tienen un formato basado en HTML, aunque también se puede encontrar ficheros de ayuda creados en PDF.

En el caso de aplicaciones Java, para generar ficheros de ayuda se utiliza JavaHelp. Cuando activamos el sistema JavaHelp en nuestra aplicación, lo primero que se hace es leer el archivo de ayuda especificado para esa aplicación. El fichero de ayuda define la ayuda para esa aplicación. Generalmente, un fichero de ayuda incluye la siguiente información:

• Mapa del fichero. El mapa del fichero se utiliza para asociar los "Identificadores de tema" con el nombre de la URL o rute de tema HTML en el fichero de ayuda.
• Vista de Información. Presenta la información descrita en los navegadores de fichero de ayuda. El estándar que se utiliza es: tabla de contenidos, índice y búsqueda de texto completo. Algunos navegadores presentan un glosario y favoritos.
• Título del fichero de ayuda. Este título aparece en la barra de título de la ventana del fichero de ayuda y en las ventanas secundarias del fichero de ayuda.
• Identificar de inicio (Home ID). El nombre del identificador por defecto que se mostrará cuando el visor de ayuda sea invocado sin especificar un ID.
• Presentación. Son las ventanas en las que se muestran los temas de ayuda.
• Sub-Ficheros de ayuda. En este caso, los ficheros de ayuda pueden estar formados por ficheros más pequeños, que son fusionados para crear el fichero de ayuda de la aplicación.
• Implementación. Esta sección es opcional y crea un registro que proporciona datos clave para definir la asignación de la clase HelpBroker para usar el método HelpSet.createHelpBroker. El registro también determina el visor de contenido de usuario para un tipo MIME.

Cuando se implementa una aplicación que utiliza JavaHelp y es instalada en el sistema del usuario, el programa Java debe ser capaz de encontrar el archivo de ayuda. La aplicación especifica la ruta al archivo de ayuda cuando se inicia el sistema de JavaHelp.

Cualquier aplicación que se implemente, va a incorporar sus propios ficheros de ayuda. Cada lenguaje de programación, en incluso cada entorno de programación, va a implementar sus propios ficheros de ayuda. Los formatos más habituales para implementar los ficheros de ayuda son:

Formato CHM. (Ayuda HTML Compilado). El fichero de ayuda compilado es un formato de ayuda online, propiedad de Microsoft. Es el formato de ayuda sucesor de Microsoft WinHelp. La ayuda se entrega en un archivo binario junto con el chm. La ayuda contiene un conjunto de archivos html, una tabla del contenido con hipervínculos y un archivo índice.

Las características de la ayuda con este formato son:

• Compresión de datos.
• Construida con motor de búsqueda.
• Posibilidad de fusionar un conjunto de ficheros de ayuda chm.

Formato HLP. Los ficheros de ayuda hlp son también conocidos como ficheros WinHelp, Los archivos de ayuda, en este formato, pueden ir acompañados opcionalmente de una tabla de contenido (fichero de extensión .cnt) si el desarrollador o desarrolladora de la ayuda lo crea. Cuando Windows abre un fichero WinHelp crea un fichero de extensión .gid en el mismo directorio, que va a contener la información del fichero .hlp tal como el tamaño de la ventana o la localización. Si la usuaria o usuario hace clic en la pestaña "Buscar", se activará la indización de palabras clave, Windows creará un archivo de índice con extensión .fts (full text search).

Un archivo de WinHelp también se puede descompilar, proporcionando copias de su contenido (hpj, cnt, rtf, bmp), usando diferentes herramientas software. Un fichero Hpj es el fichero de proyecto que es creado y editado en la herramienta Help Workshop (u otra herramienta compatible).

El hpj contiene información acerca de los ficheros RTF (Rich Text Format (formato de texto enriquecido) es un formato de archivo para documentos. La mayoría de procesadores de texto son capaces de leer y escribir documentos RTF.) compilados en la ayuda, los identificadores de mapa (MAP ID) y alias que proporcionan los enlaces para ir navegando por la ayuda.

El fichero CNT contiene la tabla de contenidos para el fichero de ayuda.

El fichero SHG es un fichero que crea un mapa de imagen para presentar gráficos en la ayuda (por ejemplo, en fichero BMP (Bit Mapped Picture). Es el acrónimo de Archivo de Mapa de Bit. Es un formato de archivo de imagen).

Archivos IPF (Information Presentation Facility). Los archivos IPF son un sistema de presentación de ayuda en línea e hipertexto en los sistemas IBM OS/2. IPF también hace referencia al lenguaje que se usa para crear el contenido IPF. El lenguaje IPF es parecido al HTML, pero añadiendo nuevas utilidades, en concreto presenta 45 comandos básicos.

Una vez que se ha editado el archivo IPF, estos se compilan con el Compilador IPF hacia un archivo INF o HLP. Estos archivos, son diferentes a los archivos WinHelp HLP que se utilizan en Windows.

Ficheros JavaHelp. Los ficheros de ayuda JavaHelp son ficheros de ayuda en línea que se implementan para aplicaciones Java, para ello se utiliza el sistema JavaHelp. JavaHelp hace referencia tanto al sistema de creación de ayuda como al formato del fichero de ayuda en línea. Los ficheros de ayuda JavaHelp se pueden visualizar en el navegador JavaHelp. Los ficheros de ayuda JavaHelp están escritos en el lenguaje Java, y básicamente es utilizado por aplicaciones Java. El formato del fichero está basado en XML (Acrónimo de eXtensible Markup Language ("lenguaje de marcas extensible"), es un metalenguaje de etiquetas que permite definir la gramática de lenguajes específicos).

Ficheros PDF

Pueden ser abiertos por cualquier visor PDF o incluso por herramientas de ofimáticas de carácter general.

Ficheros MAML (Microsoft Assistance Markup Language)

MAML es un lenguaje basado en XML, desarrollado para proporcionar asistencia al usuario ("ayuda en línea") para sistemas operativos actuales de Microsoft. También se utiliza para proporcionar información de ayuda a los cmdlets de Powershell, módulos y funciones avanzadas. Poseen la siguiente estructura:

• Preguntas frecuentes conceptual.
• Glosario
• Procedimiento de referencia
• Contenido reutilizable
• Tarea y solución de problemas.
• Tutorial.

Las herramientas de generación de ayuda nos proporcionan un entorno que nos permite crear ficheros de ayuda, para las aplicaciones que desarrollemos. Entre las más conocidas, encontramos los siguientes:

• Help Workshop. Para la creación de ficheros de ayuda hlp en Windows y páginas web que utilicen controles de navegación, la herramienta más extendida es Help Workshop. Esta herramienta ha sido desarrollada por Microsoft para la creación de archivos de ayuda para aplicaciones de Windows y páginas Web. Incluye funciones avanzadas de búsqueda de texto, una pestaña para favoritos para guardar los temas más buscados, etc. Los archivos de ayuda que crea, tienen la extensión HLP y se pueden incluir en el paquete de distribución de la aplicación y se instala con ella. Help Workshop proporciona un editor de imágenes y un gestor de proyecto, que ayuda al programador o programadora a incluir el archivo de ayuda en la aplicación que se está desarrollando. El archivo de ayuda generado, incluye un índice y una tabla de contenidos para consultar. También proporciona claves de búsqueda e hiperenlaces hacia los correspondientes contenidos. El fichero de ayuda que se obtiene con Help Workshop, incluye un control ActiveX y un applet Java para poder ser usado en cualquier navegador de Internet que soporte Java o ActiveX. El fichero de ayuda que genera esta herramienta tiene el formato CHM. Help Workshop incluye un compilador que comprime las páginas de código HTML, las imágenes, los gráficos y los diferentes archivos en ficheros CHM, que es incluido en la compilación de la aplicación, añadido a los archivos de la aplicación o descargado directamente de Internet. Esta herramienta también se puede usar para crear tutoriales y guías de usuario, para ayudar a los usuarios o usuarias finales cuando ejecuten la aplicación.

• JavaHelp. Para la creación de ayuda en aplicaciones Java, la herramienta más utilizada en JavaHelp. El JavaHelp proporciona a los desarrolladores y desarrolladoras y autores y autoras un sistema estándar, con amplias características, fácil de usar, que permite la presentación en línea de información para los usuarios y usuarias de aplicaciones Java. El sistema JavaHelp es un paquete opcional de la Plataforma Java Edición Estándar ("Java SE"). El sistema JavaHelp consiste en un completo conjunto de funciones, especificaciones y una API, además de una implementación de referencia de esa especificación y API escrita completamente en Java. El sistema JavaHelp está basado en la Java Foundation Classes (JFC, también conocida como Swing). JavaHelp proporciona una interfaz estándar que permite a los programadores y programadoras de aplicaciones y a los autores y autoras agregar ayuda en línea a sus aplicaciones. La especificación de JavaHelp y su API, permite a los desarrolladores y desarrolladoras, personalizar y ampliar el sistema de ayuda para ajustarse al estilo y las necesidades de sus aplicaciones. El sistema de JavaHelp ha sido diseñado para trabajar especialmente bien en una variedad de entornos de red. El sistema de JavaHelp es independiente de la plataforma y funciona en todos los navegadores que soportan la plataforma Java. El sistema permite a los desarrolladores Java JavaHelp para proporcionar ayuda en línea para:

  Aplicaciones, componentes JavaBeans, Applets en páginas HTML y aplicaciones Java para Servidor.

Otras herramientas de generación de ayudas son:

• RoboHelp. Es un producto para la creación de sistemas de ayuda y documentación profesionales para aplicaciones de escritorio y basadas en Web, tales como aplicación .NET y aplicaciones dinámicas de Internet.
• WINHELP. Es un desarrollo de Microsoft para proporcionar la ayuda ("Ayuda de Microsoft Windows") en el entorno Windows 95 y posteriores. Se pueden generar ficheros compatibles con este formato (.HLP). El visor nos presenta tres visiones (Tripane): la tabla de contenidos (TOC), el índice de términos y una utilidad para la búsqueda.
• WEBHELP. Es un desarrollo de ayuda basado en HTML y DHTML que funciona sobre cualquier plataforma.
• Help Magician. En el mundo de la autoría de sistemas de ayuda Help Magician es muy popular cuando se necesita crear ayudas HTML o páginas Web.
• HelpMaker: es un producto para crear ficheros de ayuda en diferentes formatos, tales como WinHelp, RTF (texto enriquecido) y HTML-Help. Nos permite crearla estructura de la ayuda. Nos permite editarla, ampliarla, añadir vínculos, etc. También posee un corrector ortográfico que nos puede venir bien si construimos ayudas en otros idiomas.
• DOCBUILDER: capaz de generar archivos de documentación y ayuda en diferentes formatos. Reconoce varios lenguajes de programación (c/c++, Pascal, Delphi) y puede generar documentación en HTML, RTF y archivos Windows de ayuda.

Toda aplicación informática, con independencia del tipo que sea (sistemas operativos, juegos, programas de gestión, programas de ofimática, etc), viene acompañados de un sistema externo al propio programa, que son las ayudas de la aplicación.

La ayuda de una aplicación tiene como objetivo orientar al usuario o usuaria de la aplicación, con las funcionalidades y uso de la aplicación en la que van incrustada. El objetivo de la ayuda es orientar sobre la forma de usar la aplicación, las posibilidades que ofrece el programa, responder al usuario o usuaria sobre preguntas comunes y toda información adicional que pueda ser útil al usuario o usuaria.

La ayuda genérica de una aplicación, va a proporcionar al usuario un entorno en el que se le van a presentar todos los contenidos de ayuda que hay diseñados. Con la ayuda genérica, a la que normalmente se accede pulsado la tecla F1, o accediendo al menú correspondiente, nos ofrece todos los contenidos de la ayuda, de forma que podemos navegar por ellos y seleccionar el tema que más nos interese. Además de la lista de contenidos, la ayuda genérica suele incluir un buscador, de forma que se puede buscar un "Término de ayuda" concreto, de modo que el sistema de ayuda nos mostrará todas las referencias que hay en la ayuda, donde aparezca ese concepto. Elegido el término de ayuda, o el contenido deseado, el sistema de ayuda nos mostrará el texto asociado, donde se nos mostrará toda la información de ayuda que hay para el mismo.

En el caso de crear la ayuda con JavaHelp, la ayuda genérica se va a encontrar almacenada en ficheros HelpSet. Para poder visualizar estos ficheros, JavaHelp provee la herramienta hsviewer. La herramienta hsviewer se puede invocar desde línea de comandos o desde Windows.

A diferencia de la ayuda genérica, donde tenemos acceso a todo el sistema de ayuda de la aplicación, la ayuda sensible al contexto, es un tipo de ayuda en línea, que muestra un conjunto de elementos de ayuda en función del software que esté activo o de la situación en la que la aplicación se está ejecutando. La ayuda sensible al contexto puede presentarse en un formulario del sistema de ayuda en línea del sistema operativo o puede ser una función que muestre una breve explicación del control que esté seleccionado en la ventana de aplicación.

Las tablas de contenidos, más comúnmente conocidas con TOC (Table of Content), es una de las partes que conforma el sistema de ayuda de una aplicación.

Dentro del sistema de ayuda de las aplicaciones informáticas, una de las partes que lo componen es la tabla de contenidos.

La tabla de contenidos es una lista de las partes que forman el documento de ayuda, organizada en la forma en la que aparecen los diferentes temas de la ayuda. Cada ítem de la lista, hace referencia a un tema principal de la ayuda, de forma parecida a las carpetas del administrador de archivos.

La tabla de contenidos, suele presentar diferentes niveles de temas, de forma que avanzamos desde un tema general a otro más específico.

La profundidad en los niveles de contenido, depende del tamaño de la ayuda y del nivel de detalle de su diseño.

Cuando el usuario o usuario de la ayuda, pulsa sobre cualquier icono de la tabla de contenidos, si es un tema general, se expande el árbol de contenidos, mostrando los temas más específicos. En el momento en que se llega a un tema ya concreto, aparecerá en la ventana de ayuda, el texto asociado a ese tema de ayuda. Normalmente, la navegación entre unos temas y otros, se hace a través de hipervínculos incrustados en el texto de la ayuda.

El objetivo de la tabla de contenidos es mostrar una visión general de todos los temas de ayuda abordados en la ayuda. Con esta información, el usuario o usuaria de la ayuda, puede navegar por la tabla de contenidos y buscar el tema que más le interesa.

Para crear la tabla de contenidos con JavaHelp, necesitamos crear un fichero TOC. Este fichero describe el contenido y la distribución de la tabla de contenidos. Su sintaxis está basada en XML.

Para facilitar el acceso a los términos de ayuda, la ayuda suele contar con un índice. El índice es una lista de palabras claves ordenadas alfabéticamente. El índice es similar a un glosario de términos o una guía de definiciones, salvo que el objetivo es aclarar un concepto o un procedimiento de uso de la aplicación en la que está insertada. Por ejemplo, si se realiza la ayuda del lenguaje de programación Java, las palabras reservadas del lenguaje serían palabras clave.

Normalmente, para acceder al índice, podemos navegar por la ventana de términos indexados, y seleccionar el que nos interese aclarar, o bien, rellenar un campo de texto y que el sistema busque el término en todas las ayudas.

Si estamos implementando aplicaciones en Java y queremos dotar al sistema de ayuda JavaHelp de un índice, podemos utilizar la herramienta jhindexer. La herramienta jhindexer es un componente del sistema JavaHelp, que sirve para crear la base de datos de búsqueda, necesaria para establecer el sistema de índices. El fichero de generación de índice, es un fichero en formato XML.

El sistema de búsquedas en la ayuda, es una herramienta que nos permite buscar todas las referencias que aparecen en la ayuda, para un término en concreto.

Para buscar un término concreto en el sistema de ayuda, el usuario o usuaria introduce la palabra a buscar en una caja de texto y activa la búsqueda de esa palabra (bien palabra completa o en títulos). Si se pulsa el botón buscar, el sistema de ayuda busca todas las páginas de ayuda en la que aparece esa palabra. El usuario de la ayuda podrá navegar por los títulos de las páginas, o por los temas en los que aparece la palabra que buscaba, y podrá ver el contenido de la ayuda para ese tema o título. En la página de ayuda, aparecerán resaltadas todas las ocurrencias de la palabra buscada, en la página en cuestión.

Si queremos implementar un sistema de búsqueda en la ayuda de nuestras aplicaciones Java, podemos utilizar la herramienta jhsearch. La herramienta jhsearch nos va a permitir buscar un término o concepto concreto, dentro de todo el sistema de ayuda JavaHelp. La herramienta jhsearch es un programa en línea de comandos que busca en la base de datos creada con Jhindexer (herramienta que crea la base de datos de búsqueda), el término sobre el que se desea obtener ayuda.

Para comprender el método de incorporación de ayuda a una aplicación, vamos a utilizar como ejemplo, la inserción de ayuda implementada con JavaHelp, en una aplicación Java.

En el proyecto que hemos realizado, incorporamos la clase URL, que forma parte del paquete java.net, la clase HelpSet y la clase HelpBroker que forman parte del paquete javax.help.

La clase URL nos permite representar una URL (Uniform Resource Locator), es decir, para identificar un recurso.

La clase HelpSet nos permite tratar desde una aplicación Java el conjunto de datos que constituyen el sistema de ayuda (fichero helpset, fichero map, tabla de contenidos, índices y topics).

La clase HelpBroker va a gestionar la visualización de la ayuda en la aplicación, incorporando métodos que nos permite añadir ayuda a la aplicación de forma sencilla (por ejemplo, el método enableHelpKey habilita la tecla de ayuda sobre un componente, el método enableHelpOnButton hace que se despliegue la ayuda cuando se presiona un determinado botón o elemento del menú y el método enableHelp indica el topic a mostrar cuando se pulse la tecla de ayuda sobre un determinado componente).

En el proyecto que estamos desarrollando incorporamos la librería jhall.jar a la aplicación e importamos los paquetes que son necesarios para la aplicación:

import javax.help.*;
import java.net.*; 

Una ver realizado lo anterior, buscamos el fichero HelpSet y creamos un fichero HelpSet, por ejemplo, con el siguiente código:

try {
          hsURL = HelpSet.findHelpset (null, “ayuda/ayuda.hs”);  // localiza el fichero helpset
          hs = new HelpSet (null, hsURL);  // crea un objeto Helpset
     } catch (Exception ex) {
          JoptionoPane.showMessageDialog (this,”Fichero HelpSet no encontrado”);
          return;
     }
     }

Una vez realizado el paso anterior, creamos un objeto HelpBroker que facilita la visualización de la ayuda en la aplicación.

hb = hs.createHelpBroker (); 

Asociamos la ayuda a un botón a un elemento del menú.

hb.enableHelpOnButton (jButton1, “introducción”, hs);

Por último, asociamos la ayuda sensible al contexto a un componente, realizando los siguientes pasos:

Hacer que el componente responda a la pulsación de la tecla de ayuda F1.

hb.enableHelpKey(getRootPane(),”introduccion”, hs);

Asociar a cada componente una página que se muestre al pulsar la tecla F1 sobre él.

hb.enableHelp(jButton1, “guardar”, hs);
hb.enableHelp(jButton2, “abrir”,hs);

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.

Un manual de usuario es un documento de comunicación técnica, que proporciona asistencia para usuarios o usuarias que utilizan un terminado sistema. Normalmente, un manual de usuario suele estar elaborado por un escritor o escritora técnica, aunque también suelen escribirlo los programadores o programadoras, ingenieros o ingenieras o los gestores o gestoras del proyecto, o cualquier otro componente del equipo de desarrollo, especialmente en compañías pequeñas.

Los manuales de usuario elaborados para aplicaciones software, ofrecen una explicación detallada de la instalación, configuración y uso, de la aplicación. Es usual que incorporen imágenes, con captura de pantalla de la ejecución del programa.

Las secciones de una manual de usuario suelen incluir los siguientes contenidos:

• Portada.
• Página de título y página de copyright.
• Prólogo, que muestra detalles de los documentos relacionados e información sobre cómo navegar por la el manual de usuario.
• Páginas de contenidos, donde se muestra un índice con los contenidos de manual.
• Una guía de cómo usar, al menos, las funciones básicas de la aplicación.
• Una sección de solución de problemas, donde se detallan problemas y posibles soluciones que pueden surgir, junto con la forma de solucionarlos.
• Una sección FAQ (Frequently Asked Questions, se refiere a una lista de preguntas y respuestas que surgen frecuentemente dentro de un determinado contexto y para un tema en particular).
• Donde encontrar más ayuda para uso de la aplicación.
• Un glosario y un índice.

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.

Los usuarios y usuarias de una aplicación informática, a menudo quieren la documentación en un formato que:

• Les dé una visión genérica da la misma, y
• Les permita su uso lo más rápidamente posible.

Las guías rápidas proporcionan una versión corta de un manual. A pesar de la brevedad de los materiales de referencia rápida, el proceso de pensamiento involucrado en la creación, organización, y la disposición de su contenido no resulta trivial, ya que se necesita evaluar el contenido del manual y decidir la información más importante que el usuario necesita saber.

Cuando un desarrollador o desarrolladora comienza un nuevo proyecto, es necesario evaluar las ventajas que puede aportar, la implementación de una guía rápida. Una guía rápida es ideal en los siguientes casos:

• Aplicación que requiere una sola configuración: si la aplicación solo tiene que configurarse una vez durante el proceso de instalación, la aplicación está operativa de forma rápida. La guía rápida permite al usuario o usuario final los conocimientos básicos para utilizar la aplicación.
• Aplicación con funcionalidad limitada: si una aplicación tiene un número muy limitado de tareas, no será necesario una documentación muy extensa.
• Documentación muy extensa: si una aplicación tiene un gran volumen de documentación, porque es una aplicación muy compleja, una guía rápida permitirá la ejecución de las tareas principales, de forma que cuando un usuario necesite ejecutar tareas más complejas, puede consultar el manual, o la ayuda, pero ya está capacitado para ejecutar las tareas básicas.
• Usuarios que no puedan dedicar mucho tiempo a la formación, en aplicaciones que migran a una versión nueva, etc.

Para desarrollar la guía rápida, hay que decidir el contenido que va a incluir. Si la guía rápida forma parte de una documentación más amplia, primero se desarrolla esta. Teniendo una visión global del producto, podemos decidir los aspectos más importantes que puedan permitir a un usuario utilizar la aplicación. Las tareas esenciales serán las que incluiremos en la guía rápida.

Existen muchas plantillas para el desarrollo de guías rápidas, sin embargo, cada aplicación va a requerir un diseño específico. Para el diseño gráfico de la guía de referencia rápida, se deben tener presente estos cuatro aspectos: contraste, repetición, alineación y proximidad.

El contraste nos permite establecer relaciones jerárquicas entre la información, por ejemplo, usar contraste entre los títulos y el texto, ayuda al usuario o usuaria a entender mejor la estructura del documento. También el contraste nos sirve para llamar la atención. La repetición de un diseño consistente en todo el documento, da integridad a la totalidad del mismo. Por ejemplo, la repetición de un logotipo, de un determinado color, etc.

Es necesaria la alineación del texto, ya que mantener la simetría entre los párrafos, imágenes, títulos y otros elementos, mantiene relajados los ojos. La proximidad se refiere a la agrupación de objetos interrelacionados. En una guía rápida se deben agrupar las tareas importantes en la columna principal, manteniendo las tareas subordinadas en la columna lateral.

Los manuales de instalación están dirigidos a administradores o administradoras de sistemas y usuarios o usuarias con privilegios de instalación de aplicaciones. Los manuales de instalación proporcionan información detallada de como instalar la aplicación en un entorno determinado. Estos manuales de instalación contienen descripciones de los archivos que componen la aplicación, el sistema operativo para el que está diseñado, los requerimientos mínimos de hardware, etc. El manual de instalación también debe suministrar información sobre posibles modificaciones en los archivos del sistema anfitrión, modificación de variables de entorno, instalación de software adicional para que la aplicación pueda funcionar (por ejemplo, la máquina virtual Java), cómo cualquier aspecto necesario, que se requiera para poder instalar la aplicación en un sistema concreto.

Actualmente, el uso de programas instaladores para aplicaciones, tanto en sistemas Windows como en sistemas Linux, hacen que sea, en la mayoría de los casos, innecesario la creación de manuales de instalación, por lo que muchos proveedores de software ya no los elaboran. No obstante, para determinadas aplicaciones de cierta envergadura, sobre todo en ambientes multiusuario, se utilizan los manuales de instalación para ayudar a los administradores y administradoras de sistemas a descubrir y solucionar problemas con la instalación.

Cuando se instala una nueva aplicación, una de las labores más importantes es la configuración. El manual de configuración de la aplicación facilita información sobre los valores que deben tener algunas variables de la aplicación. Al modificar el valor de esas variables (por ejemplo, directorio de instalación, acceso directo en escritorio, …), el programa se podrá instalar de manera personalizada.

En la mayoría de los programas de uso general que se distribuyen, se suele establecer una configuración predeterminada, en donde la persona que realiza la instalación del software no modifica ninguna variable destacable de la instalación. La configuración predeterminada no requiere manual y está destinada a usuarios y usuarias de todas las edades, con un nivel medio-bajo de conocimientos informáticos.

Hay otros tipos de aplicaciones, incluidos los sistemas operativos, que requieren una configuración personalizada, definida por el usuario o usuaria. El manual de configuración aportará información sobre cómo realizar los cambios en la aplicación para personalizarla. En sistemas como Linux, la configuración de aplicaciones es muy importante y no es una tarea trivial, ya que se requieren modificar scripts de texto plano, lo cual puede inducir a errores. En el manual de configuración se deberán indicar detalladamente los archivos que se deben modificar, las variables a modificar, y los posibles errores que se pueden cometer, así como la recuperación de los mismos.

Cuando hablamos de manual de administración, nos referimos al manual que va destinado específicamente a administradores o administradoras de sistemas. En los manuales de administración, aparece la información necesaria para la operativa y mantenimiento del sistema informático. El manual de administración incluye información sobre los comandos que se pueden utilizar. Los manuales de administración también suelen describir los mensajes generados cuando el sistema esta interactuando con otros sistemas o con aplicaciones o usuarios o usuarias. Los manuales de administración explicaciones de cómo realizar las tareas de mantenimiento del hardware. Un ejemplo de información que describe el manual de administración es cómo solucionar fallos a través de la consola, como conectar nuevos periféricos, etc.

Cuando se elaboran manuales para aplicaciones software o sistemas operativos, hay que distinguir diferentes tipos de usuarios y usuarias a los que van destinados. Cada grupo de usuarios o usuarias, tienen definido un papel determinado dentro del sistema informático, y cada grupo tiene unos privilegios y conocimientos específicos.

Se pueden distinguir los siguientes destinatarios:

• Administradores o administradoras del sistema: Para este tipo de usuarios se suele destinar el Manual de Instalación y el Manual de Configuración y Administración.
• Usuarios o usuarios experimentados: Para este tipo se suele destinar el Manual de usuario, la Guía Rápida y la Guía de Referencia.
• Usuarios o usuarios poco experimentados: Para ellos se define la Guía Rápida y el Manual de Usuario.

La estructura de un manual es la forma en la que el documento se organiza en capítulos, estos capítulos en apartados y subapartados. La estructura del documento tiene un gran impacto en la facilidad de lectura y en la usabilidad y es importante su diseño cuando se crea la documentación. La estructura que se recomienda que posean manuales, debería tener los siguientes componentes:

Un tutorial multimedia incorpora un conjunto de recursos de diferente tipo, para ofrecer información visualmente atractiva, sobre un determinado tema, software, herramienta, etc.

Cualquier tutorial multimedia que quiera tener calidad, necesita de una buena información base, teniendo siempre presente el tipo de usuario o usuaria a la que va destinado. La información se va a complementar con imágenes, vídeos, sonidos, animaciones, gráficos, enlaces externos o cualquier otro recurso que permita completar y mejorar la calidad del tutorial que se está implementando.

Las capturas de pantalla permiten crear una imagen del escritorio del ordenador, una determinada ventana o un área específica. Esta imagen puede ser manipulada e incrustada en un documento, permitiendo la creación de manuales multimedia a medida.

La forma más simple de realizar una captura de pantalla es con la tecla PrintScr (también llamada Impr Pant) y un programa de imagen donde poder usar el Portapapeles. Si lo que desea es capturar la ventana activa, se utiliza la combinación Alt + Impr Pant. En los sistemas operativos Windows podemos utilizar la herramienta Recortes para realizar capturas de pantalla.

En el mercado existen bastantes aplicaciones que permiten la captura de pantalla, por ejemplo, el programa GIMP trae una opción de captura, y el sistema operativo Ubuntu, trae una opción en el menú principal para la captura de pantalla. Sin embargo, existen aplicaciones diseñadas específicamente para capturar la pantalla como, por ejemplo: Snagit, Hypersnap DX, Screenshot Captor, Easy Capture y WinSnap, entre otras. Las herramientas Snagit e Hypersnap Dx son capaces de capturar aplicaciones DirectX, también lo son de capturar texto, zonas seleccionadas a mano y varias ventanas/controles de una vez. Snagit añade a eso otras opciones cómo la captura de vídeo, la adquisición desde cámaras y escáner, de imágenes de páginas web o recursos (iconos, cursores, gráficos) de programas, entre otros. Otra de las funciones más importantes consiste en la captura de ventanas con desplazamiento, el único que no dispone de este tipo de captura es WinSnap, si bien en el resto se produce con distinta eficacia.

Actualmente es muy común la creación de videotutoriales. Los videotutoriales, también llamados Screencasts, son tutoriales elaborados en vídeo.

Existen numerosas herramientas para la realización de videotutoriales, siendo las más populares: CamStudio,Camtasia, Jing, Matchware ScreenCorder, AdobeCaptitave.

La forma más simple de realizar una capturar de pantalla, es mediante la tecla Imprimir Pantalla (Impr Pant)., esta secuencia de teclas, crean una imagen con todos los elementos que aparecen en el escritorio del sistema. Esta imagen pasa al portapapeles con lo que, con cualquier programa de edición de imágenes, como Paint en Windows, podemos generar un fichero de imagen, que se podrá editar y exportar a diferentes formatos (bmp, jpg, gif, etc). Las imágenes obtenidas de esta forma, son muy útiles para la elaboración de manuales de usuario y tutoriales, para aplicaciones informáticas.

En el caso de que queramos realizar la captura de pantalla, pero en vez de generando una imagen, con un vídeo, es necesario la utilización de alguna herramienta especifica. En todas las herramientas, la secuencia de acciones para la elaboración de vídeo son similares. 

Existen diferentes herramientas para la creación de tutoriales interactivos, tanto software libre como software comercial. Entre el software comercial más extendido para crear de tutoriales multimedia, destaca Adobe Captivate, y como software libre: Wink. Otro ejemplo de herramienta libre y utilizada por el Ministerio de Educación para la creación de tutoriales multimedia es Malted.

Wink es una herramienta que permite la creación de tutoriales interactivos. Permite la captura de pantalla, creación de captura de vídeo, puede añadir globos con explicaciones, botones, títulos, etc., generando un tutorial bastante completo.

La herramienta de creación de tutoriales interactivos Malted, permite la creación de ejercicios y unidades de trabajo utilizando como base el código XML. La herramienta proporciona un editor que permite generar ejercicios, contenidos, incorporación de texto, imágenes, gráficos, audio y vídeo. Este editor permite creación de unidades de trabajo organizadas en función de una planificación didáctica, posibilitando la navegación entre los contenidos siguiendo un orden lógico.

Para simular las ejecuciones de aplicaciones informáticas, es muy común el uso de tutoriales multimedia. La simulación permite al usuario o usuaria conocer los procesos de instalación, configuración y ejecución de una aplicación. Al permitir la interacción, el usuario puede explorar la aplicación, conocer su entorno y simular su uso.

Los tutoriales interactivos permiten que el grado de realismo de la simulación venga determinado por el uso de vídeo, imágenes, sonidos y por el realismo de la interfaz. El usuario o usuaria simula ejecutar la aplicación y toma decisiones interactuando con el tutorial a través del teclado y del ratón.

Las simulaciones en el mundo educativo están adquiriendo una importancia muy notable gracias a Internet. Es un elemento básico en e-learning. Aquí la simulación juega un papel muy importante. En educación los vídeos ayudan al alumnado a solucionar problemas y adquirir conocimientos, pero con la simulación se pueden usar vídeos con caricaturas hipotéticas e historias basadas en la realidad, de forma que la clase interactúa en la enseñanza y el aprendizaje. Asimismo, la simulación puede evaluar el aprendizaje, resolver problemas de habilidades en el alumnado, adaptarse a las necesidades del profesorado etc.