3.

Elaboración de manuales

3.1 Descripción funcional

Es un documento de comunicación técnica diseñado para ayudar a los sujetos

que usan un sistema. Esta guía puede ayudar a las personas a comprender
cómo funcionan ciertas cosas.

Además de su particularidad, el autor del manual también trata de llegar a la

mayor cantidad posible de destinatarios en un lenguaje agradable y simple.
Este tipo de publicación proporciona a los usuarios las instrucciones
necesarias para usar productos o servicios específicos.

3.2 Manual de instalación

El manual de instalación está destinado a guiar la instalación de un sistema.

Para hacer esto, primero, se debe especificar los requisitos de hardware y
software necesarios para ejecutar el sistema correctamente, y luego describir
cada paso requerido para configurar, compilar e instalar el sistema. Además,
debe incluir las pruebas que deben realizarse para garantizar que la
instalación se realice correctamente y los pasos inversos que deben seguirse
en caso de que la instalación del sistema no se realice con éxito.

3.3 Manual de operación (usuario)

Las guías de usuario, también conocidas como manuales de usuario, son

documentos de comunicación técnica diseñados para ayudar a las personas a
utilizar productos específicos.

La estructura común del manual del usuario incluye una introducción al

producto involucrado (por ejemplo, un programa), un índice del contenido del
 manual, la guía en sí, partes relacionadas con problemas comunes y sus
soluciones, información de contacto y glosario.

Este documento generalmente es elaborado por un escritor técnico (por

ejemplo, un programador de sistemas o gerente). Debe estar escrito de tal
manera que cualquiera pueda entenderlo con la menor dificultad. Se
recomienda detallar todos los pasos para utilizar el producto. Sin olvidar
especificar el alcance y las limitaciones del mismo. Un buen punto de partida
para los manuales de usuario es tomar en cuenta que las personas que
pretendan leer el manual no tienen ningún conocimiento sobre el producto.

Los manuales de usuario generalmente están escritos en diferentes idiomas y

tienen texto e imágenes. De esta manera, se promueve la comprensión de los
conceptos. Los gráficos y diagramas también son muy comunes.

Las guías de usuario suelen asociarse con productos electrónicos, como

computadoras y programas.

3.4 Manual de administrador

Este manual sirve de base para la capacitación técnica del personal

administrativo encargado de la administración del sistema.
Este manual otorga conocimientos entorno a las directrices que se deben
tener en cuenta para la entrega de contenidos en el sistema.

En este se encuentran normativas, recomendaciones y algunos ejemplos que

sirven de ayuda para gestionar el sistema.
Adicionalmente en este manual también puede incluir indicaciones para
otorgar los permisos y roles a los demás usuarios que hacen uso del sistema.
3.5 Guía de referencia rápida

La guía de referencia rápida es el documento que deriva de un resumen de

uso y recomendaciones de una guía de práctica y que presenta al usuario la
información en un formato que facilita el acceso expedito. En su reproducción
impresa en papel, se pretende que su tamaño permita ser distribuido de forma
práctica.

Con el fin de lograr el objetivo de su rápida accesibilidad, la guía de referencia

rápida utiliza predominantemente un lenguaje visual, gráfico, que debe seguir
ciertas reglas mutuamente compartidas entre autores.

3.6 Manual técnico del sistema

Este documento contiene toda la información sobre los recursos utilizados por
el proyecto, y tienen una descripción muy detallada de las características
físicas y técnicas de cada elemento. Por ejemplo: características del
procesador, velocidad, tamaño del dispositivo, garantía, soporte, proveedores
y otros dispositivos.
Su expansión depende de la cantidad de recursos y equipos utilizados, y
generalmente se presenta en forma de una tabla técnica, que describe cada
característica de cada recurso.