Manual de Usuario

Son guas escritas en diferentes formatos, ya sea en

papel o en documentos electrnicos (PDF o XPS), las
cuales proporcionan instrucciones de cmo hacer o
utilizar algo.
Algunos ejemplos de guas de usuario son para
programas de computacin, pueden acompaar a
computadoras, dispositivos electrnicos (televisores,
radios estreo, sistemas telefnicos y reproductores
MP3), electrodomsticos y equipos de jardinera.
 Su funcin principal consiste en informar al
usuario acerca del producto y le ensean a
utilizarlo de manera efectiva, de tal forma que
puedan leerse y consultarse fcilmente

Dichos manuales estn compuestos de 3 puntos:

Crear la documentacin de usuario apropiada
Componentes del manual de usuario
Disear un manual de usuario legible
 Para escribir un manual de usuario exitoso,
debes desarrollar un perfil de usuario, ya sea
creando un perfil escrito o tomndote el
tiempo de realizar suposiciones razonables
acerca de las caractersticas del usuario
 Las cosas a tener en mente cuando formas un
perfil de usuario son:
El lugar donde los usuarios utilizarn la gua de
usuario, como en las casa, oficina, en un lugar de
trabajo, incluso en el auto, determinando no solo el
contenido, sino tambin el estilo que tome el
manual de usuario.
 De que manera los usuarios utilizarn la
gua?
Si solo consultara el manual pocas veces o para
buscar informacin, se recomienda tener un
formato como el de un documento de consulta,
pero si los usuarios consultarn el manual con
frecuencia, debe estar acompaada de una seccin
titulada Cmo empezar y de instrucciones de las
tareas ms simples del producto.
 La experiencia del usuario con el producto u otros
productos similares.
Si tu producto es nuevo o significativamente diferente de
otros productos similares, debers incluir una explicacin
de cmo es distinto comparado con otros productos y
tambin instrucciones de cmo comenzar a utilizarlo, pero
si el producto est relacionado con algo que
frecuentemente resulta problemtico para los usuarios
(normalmente en muchos programas de computacin), se
debe proporcionar una informacin adecuada y detallada de
una forma comprensible.
 A menos que el usuario tenga antecedentes tcnicos, es
mejor evitar el lenguaje tcnico, tomando explicaciones
ms claras y simples, debe estar organizado de manera
similar a como piensa el usuario.
Algunas veces es inevitable utilizar trminos tcnicos,
por lo que es til definir el trmino y proporcionar algo
de informacin bsica al respecto.
 Ofrecer una solucin a un problema comn, para
ellos es importante identificar los problemas
especficos que el usuario enfrentar, mencinalos
en la gua de usuario y luego aade las
instrucciones para resolverlos.
Pero, si el problema es complejo, sepralo en
partes ms pequeas.
 Se debe incluir una portada para cualquier mayor a
una hoja, as como una cartula.
Si el manual tiene la proteccin de los derechos de autor,
se debe incluir un aviso de derechos de autor en la portada
y en la cartula.
Si existen trminos y condiciones para usar el manual y el
producto asociado a este, colcalos en la portada interior.
 Si la documentacin de usuario es ms que un solo
manual, coloca las referencias a los dems
documentos, con su nmero de versiones
correspondientes.
 Si el manual se excede de las 10 pginas, se
recomienda incluir un ndice de contenidos.
 Las imgenes grficas o las capturas de pantalla pueden
ilustrar algunos puntos mejor que un texto, en especial
si se trata de procedimientos complejos.
Si utilizas muchas imgenes grficas en los procedimientos,
hazlas de un tamao consistente, ya sea en las mismas
medidas de ancho y alto o en la misma proporcin de
reduccin con respecto al tamao original, haciendo que la
imagen luzca ms atractivas para el usuario.
 Una vez que hayas elegido las fuentes del manual de usuario,
debers decidir dnde debe estar colocada cada cosa en las
pginas.
Es conveniente poner el ttulo del manual o del captulo en el encabezado
o en el pie de pgina y colocar el nmero de pgina en el encabezado o en
el pie de pgina.
Colocar el texto de las referencias de las imgenes en colores o en
recuadros sombreados para separarlo del resto del texto, es importante
elegir un color o un nivel de sombreado que permita leer el texto con
facilidad.
 Es recomendable crear anticipadamente todos los
estilos que puedas necesitar, as no tendrs que
detenerte para crearlos mientras ests escribiendo
realmente el manual.