PASOS PARA ELAVORAR UN MANUAL DE USUARIOS
El manual de usuario es un documento técnico de un determinado sistema que intenta dar asistencia que sus usuarios.
Los manuales de usuario generalmente son incluidos a dispositivos electrónicos, hardware de computadora y aplicaciones. El manual de usuario puede venir tanto en forma de libro como en forma de documento digital, e incluso poder ser consultado por internet.
En general, un manual de usuario debería poder ser entendido por cualquier usuario principiante, como así también serle útil a usuarios avanzados.
Un manual de usuario completo suele tener:
* Un prefacio, con información sobre cómo usar el propio manual.
* Un índice.
* Una guía rápida rápida sobre cómo usar las funciones principales del sistema.
* Una sección para la resolución de problemas.
* Una FAQ (tipo de archivos).
* Información de contacto.
* Un glosario.
Los manuales de usuario generalmente son incluidos a dispositivos electrónicos, hardware de computadora y aplicaciones. El manual de usuario puede venir tanto en forma de libro como en forma de documento digital, e incluso poder ser consultado por internet.
En general, un manual de usuario debería poder ser entendido por cualquier usuario principiante, como así también serle útil a usuarios avanzados.
Un manual de usuario completo suele tener:
* Un prefacio, con información sobre cómo usar el propio manual.
* Un índice.
* Una guía rápida rápida sobre cómo usar las funciones principales del sistema.
* Una sección para la resolución de problemas.
* Una FAQ (tipo de archivos).
* Información de contacto.
* Un glosario.
Objetivo
El manual está diseñado para ayudar a los usuarios noveles a navegar y a utilizar las diferentes herramientas software incluidas en la distribución Tirwal.
Uno de los objetivos fundamentales del Manual de Usuario es facilitar la tarea de conocimiento, uso y aprendizaje de la distribución Tirwal. Sin embargo, se ha de tener siempre presente que los métodos, mecanismos de trabajo y las propias herramientas software difieren de las utilizadas por otros sistemas operativos. Por tanto, es aconsejable acercarse a Tirwal con una mentalidad abierta, viendo la distribución como una alternativa completa y real.
El manual de usuario contiene información acerca de todas las operaciones básicas para la mayoría de los usuarios. Da una visión completa de la utilización de Tirwal a nivel de usuario, explicando con detalle el funcionamiento de las herramientas software e incluyendo capturas de pantallas útiles para el seguimiento de la explicación.
El manual contempla la utilización de dispositivos de almacenamiento externo como son los disquetes, CD, CD-RW y DVD. Configuraciones básicas, como el teclado, fecha y hora.
Los pasos para hacer o elaborar un manual, de manera muy generalizada, para que los adaptes a tus necesidades particulares:
1- Definir el tema: debes acotar el alcance o profundidad del manual, en el fondo lo que vas a cubrir, para no extralimitarte o hacerlo demasiado breve.
2- Relacionado con el punto 1, debes visualizar al lector objetivo al cual está dirigido el manual, para adaptar el lenguaje utilizado en el mismo y lo "técnico" de sus párrafos, a este lector o usuario.
3- Define la estructura, en el fondo los temas a tratar, desde la introducción hasta los últimos consejos (es común una sección de FAQs o trouble-shooting como anexo). Directamente relacionado a esto se encuentra la necesidad de definir el medio de difusión: en las versiones impresas, en general se permiten párrafos más extensos y detallados quen en las guías o manuales en línea, donde deberás ser más conciso y al grano, para evitar esos largos scrolls para bajar la pantalla.
4- Toma manuales de temas similares, para tomar ideas y afinar la estructura, antes de comenzar.
5- Redacta el manual, tomando en cuenta todo lo anterior, y luego pásalo a diferentes personas que se ajusten a tu público objetivo, a ver si entienden bien el contenido, y toma sus recomendaciones, para elaborar así una versión final.
1- Definir el tema: debes acotar el alcance o profundidad del manual, en el fondo lo que vas a cubrir, para no extralimitarte o hacerlo demasiado breve.
2- Relacionado con el punto 1, debes visualizar al lector objetivo al cual está dirigido el manual, para adaptar el lenguaje utilizado en el mismo y lo "técnico" de sus párrafos, a este lector o usuario.
3- Define la estructura, en el fondo los temas a tratar, desde la introducción hasta los últimos consejos (es común una sección de FAQs o trouble-shooting como anexo). Directamente relacionado a esto se encuentra la necesidad de definir el medio de difusión: en las versiones impresas, en general se permiten párrafos más extensos y detallados quen en las guías o manuales en línea, donde deberás ser más conciso y al grano, para evitar esos largos scrolls para bajar la pantalla.
4- Toma manuales de temas similares, para tomar ideas y afinar la estructura, antes de comenzar.
5- Redacta el manual, tomando en cuenta todo lo anterior, y luego pásalo a diferentes personas que se ajusten a tu público objetivo, a ver si entienden bien el contenido, y toma sus recomendaciones, para elaborar así una versión final.