¿Cómo hacer un manual, cuáles son los pasos para elaborarlo?


raul - Hace mas de un año - Reportar abuso

Respuestas

 

francisd...

En realidad hay muchas maneras de hacerlo y depende del tipo de manual que vas a hacer. Por ejemplo en biología, física y química (sobre todo con fines pedagógicos) los manuales deben ser muy detallados para que la persona no cometa algún error (en ciencias básicas un error puede lastimar a alguien). Veamos los pasos. El primero y más importante es que tú conozcas el procedimiento con detalle, si no conoces bien de lo que vas a hablar, más bonito cayadito. El segundo es hacer un diagrama de flujo donde pongas los pasos principales del procedimiento numerado para mayor orden (por lo general yo lo hago mentalmente pero mi mejor consejo es tomarse un rato para ello). Tercer paso es realizar el procedimiento y describirlo en un texto siguiendo como base el diagrama que has hecho previamente. Puedes ir indicando en cada parte que materiales has utilizado para luego hacer una lista de los mismos (en informática casi nunca se necesita, pero es bueno indicar el programa que se va a usar y la versión pues muchos programas cambian significativamente de una versión a otra). También es una buena idea (sobre todo en informática) añadir imágenes ilustrativas de los diversos pasos, entre menos alteradas mejor, muchos piensan que añadiendo "flechas", "globos" y hasta números ayudan a ilustrar, cuando lo que hacen es confundir, créanme he visto a personas adultas preguntar donde está la flechita o el globo, lo más indicado es decir "busque el botón o el cuadro que diga ..." y el texto que se debe buscar en negrilla o cursiva. Por último uno debe leer su propio manual y ejecutar nuevamente el procedimiento siguiendo esta ves el mismo manual, aquí es donde uno encuentra errores de procedimiento que puede corregir aunque sería mejor que otra persona lo hiciese por uno y la crítica constructiva resulta la mejor de las ayudas. Muchas veces un manual es inútil porque el que lo hizo dio por sentado que su alumno tenía ciertos conocimientos previos pero yo nunca doy por sentado eso. Mis manuales a veces redundan en detalles pero siempre he recibido buenas críticas y muchos dicen que hasta personas inexpertas en el tema podrían seguirlos. Uno debe escuchar mucho las críticas de los demás compañeros de profesión pero son sus alumnos los que te enseñan más. Suerte.
Puntaje: - 5.00 - 1 votos - Votar: Reportar abuso

 

pedrolo

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 diferente 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.

Suerte con ese manual!
Puntaje: - 5.00 - 1 votos - Votar: Reportar abuso