Manual
de instrucciones
Un manual de instrucciones es una libreta en el que se explica paso
a paso como realizar cierta tarea. Puede encontrarse en:
- En el
mundo de la informática es muy habitual
encontrarlo, para realizar la instalación de una aplicación correctamente
y qué hacer en caso de tener algún problema.
- Es
también habitual encontrar uno cuando compramos cualquier aparato electrónico de cierta complejidad.
- Instrucciones de seguridad, en manufacturas cuya utilización inadecuada podría acarrear riesgos para la salud del usuario.
Tipos de manuales
Los manuales
son textos utilizados como medio para coordinar, registrar datos e
información en forma sistémica y organizada. También es el conjunto
de orientaciones o instrucciones con el fin de guiar o mejorar la eficacidad de
las tareas a realizar.
Pueden
distinguirse los manuales de:
Organización: este tipo
de manual resume el manejo de una empresa en forma general. Indican la
estructura, las funciones y roles que se cumplen en cada área.
Departamental: dichos
manuales, en cierta forma, legislan el modo en que deben ser llevadas a
cabo las actividades realizadas por el personal. Las normas están dirigidas al
personal en forma diferencial según el departamento al que se pertenece y el
rol que cumple
Política: sin ser
formalmente reglas en este manual se determinan y regulan la actuación y
dirección de una empresa en particular.
Procedimientos:
este manual determina cada uno de los pasos que deben realizarse
para emprender alguna actividad de manera correcta.
Técnicas: estos
manuales explican minuciosamente como deben realizarse tareas particulares, tal
como lo indica su nombre, da cuenta de las técnicas.
Bienvenida: su función
es introducir brevemente la historia de la empresa, desde su origen, hasta la
actualidad. Incluyen sus objetivos y la visión particular de la empresa. Es
costumbre adjuntar en estos manuales un duplicado del reglamento interno
para poder acceder a los derechos y obligaciones en el ámbito laboral.
Puesto: determinan
específicamente cuales son las características y responsabilidades a las
que se acceden en un puesto preciso.
Múltiple: estos
manuales están diseñados para exponer distintas cuestiones, como por ejemplo
normas de la empresa, más bien generales o explicar la organización de la
empresa,
siempre expresándose en forma clara.
Finanzas: tiene como finalidad verificar la administración de todos los bienes que pertenecen a la empresa. Esta responsabilidad está a cargo del tesorero y el controlador.
Sistema: debe ser
producido en el momento que se va desarrollando el sistema. Está
conformado por otro grupo de manuales.
Guía
del usuario
Una Guía de usuario, también conocida como Manual de usuario,
es un documento de comunicación técnica destinado a dar asistencia a las personas que utilizan un sistema en
particular.Por lo general, este documento esta redactado por un escritor técnico,
como por ejemplo los programadores del sistema o los directores de proyectos
implicados en su desarrollo, o el personal técnico, especialmente en las
empresas más pequeñas.
Los Guías del usuario son más comúnmente asociados con los productos
electrónicos, como computadoras y programas.
La mayoría de las guías de usuario contienen tanto una guía escrita como
imágenes asociadas. En el caso de las aplicaciones informáticas, es habitual
incluir capturas de pantalla de cómo el programa debería ser, y manuales que a
menudo incluyen diagramas claramente detallados y sencillos que detallan los
pasos a realizar por el usuario para llevar a cabo las distintas opciones
disponibles. El lenguaje utilizado deberá ser sencillo, dirigido a una
audiencia que podrá no entender un lenguaje demasiado técnico.
Secciones básicas del manual
de usuario
Las secciones de un manual de usuario a menudo incluyen:
- Una página de portada.
- Una página de título.
- Una página de derechos de
autor.
- Un prefacio, que
contiene detalles de los documentos relacionados y la información sobre
cómo navegar por la guía del usuario.
- Una página de contenido.
- Una guía sobre cómo utilizar al menos las principales funciones del
sistema, es decir, sus funciones básicas.
- Una sección de solución de problemas que detalla los
posibles errores o problemas que pueden surgir, junto con la forma de
solucionarlos.
- Una sección de preguntas frecuentes.
- Dónde encontrar más ayuda, y datos de contacto.
- Un Glosario y,
para documentos más grandes, un Índice.
Manuales y guías de programas
informáticos
Los Manuales de usuario y Guías de usuario para la mayor parte de las
aplicaciones de software contienen comúnmente todos los contenidos detallados
en el apartado anterior. El Starta User Manuales un buen ejemplo de este tipo de documento. Sin embargo, algunos
documentos tienen una estructura más fluida con muchos enlaces internos. El Google
Earth User Guide es un ejemplo de este tipo de manuales.
El término guía se suele aplicar a un documento que aborda un aspecto
específico de un producto de software. Algunos ejemplos son: Guía de
Instalación o Guía de Introducción. Un ejemplo de este tipo es la
guía de introducción a Picasa.
En algunos sistemas software de negocios, donde los grupos de usuarios
tienen acceso sólo a una de la funcionalidad total de la aplicación, es bastante
aconsejable preparar una guía de usuario para cada grupo. Un ejemplo de este
enfoque puede observarse en la guía Autodesk Topobase 2010 Help[, que contiene por separado una Guía del Administrador y las distintas
Guías de Usuario, además de una Guía para desarrolladores. Estos manuales son
una herramienta valiosa para el entrenamiento en el trabajo.
1. Para que nos sirve un manual de instrucción
2. Explica 5 tipos de manual de instrucción
3. Explica para que utilizamos la guía de usuario en informática
4. Que secciones incluye un manual de usuario
