Saltar la navegación

8.6.- Destinatarios y estructura.

Caso práctico

Al finalizar la creación de la documentación para la aplicación de Gestión Hotelera, Ada enumera los diferentes manuales y guía que se han desarrollado, indicando las características más importantes de cada una y el tipo de usuarias y usuarios a los que van destinadas.

Imagen de cinco personas sentadas en una mesa, donde hay un proyector funcionando y una mujer explicando algo, mirando hacia una pantalla.
Ministerio de Educación y Formación Profesional (Elaboración propia)



Imagen en donde se muestra una sala de ordenadores.
Intef (CC BY-NC-SA)


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:

Estructura de un manual
Componente Descripción
Dato identificativo Título que identifique de manera unívoca al documento
Tabla de contenidos Título de cada apartado y subapartado, junto con el número de página
Lista de ilustraciones Número de figura y título
Introducción Define el objetivo del documento con una breve descripción de los contenidos
Información de uso de la documentación Sugerencias para los diferentes tipos de lectores de cómo usar eficientemente la documentación
Procedimientos Directrices de cómo usar el software para completar las tareas para las que se ha diseñado
Información de los comandos Una descripción de cada comando soportado por el software
Mensajes de error y resolución de problemas Una descripción de los errores que se pueden informar y cómo recuperarse de ese error
Glosario Definición de los términos especializados que se ha utilizado
Fuentes de información relacionadas Referencias o enlaces a otros documentos que proporcionan información adicional
Elementos de navegación Elementos que permitan a los lectores buscar su localización actual y moverse en todo el documento
Índice Una lista de términos clave y de las páginas donde esos términos están referenciados.
Capacidad de búsqueda En documentación electrónica, facilidad para encontrar un término específico en el documento

Debes conocer

Usabilidad es la facilidad con que la personas pueden utilizar una aplicación informática con el fin de alcanzar un objetivo concreto.