Un tutorial para elaborar un tutorial

Ya sabes que el término tutorial es un neologismo de origen inglés del ámbito de la informática y que no forma parte del Diccionario de la Real Academia Española. Se trata, pues, de un tecnicismo.

Y tamabién sabes que se trata de una serie de instrucciones conectadas, una guía paso a paso, que busca enseñar una tarea a un usuario  que no tiene los conocimientos necesarios para utilizar un producto (herramienta, máquina, a plicación informática, etc.), o para poder realizar un trabajo. Pero,…

 ¿CÓMO HAY QUE elaborar un tutorial?

Imagen adaptada de http://www.wikio.es/

Aquí tienes la receta:

1. Planifica. Piensa en lo que debes enseñar y cómolo harás para que sea claro ycomprensible fácilmente.
2. Busca las herramientas y accesorios que utilizarás; antes de empezar debes tenerlos a mano. Por ejemplo, necesitasuna captura de pantalla o una vídeo, realízalos antes de elaborar el tutorial.
3. Redacta el tutorial. Ten cuenta los siguientes aspectos y respeta el orden:
1. El título. Debe ser lo suficientemente claro para que el lector determine si le interesa o no, si lo necesita o no. Por ejemplo: Publicar un comentario en un blog, Google Docs, 1: Compartir documentos y carpetas, Receta para elaborar la memoria de un proyecto, etc.
2. Observaciones. Antes de comenzar con las instrucciones, puede ser conveniente realizar una serie de recomendaciones y consejos, como por ejmplo, una explicación de los métodos y programas que usarás, enlaces de descargas de programas que se van a utilizar; en definitiva, una lista de los “ingredientes” necesarios o una advertencia de los posibles problemas con los que se puede encontrar el receptor y los consejos para superarlos.
3. Las instrucciones paso a paso. Todos los tutoriales deben seguir un paso a paso claro y conciso; sin palabras de más, pero sin pasos de menos: no des nada por supuesto ni por obvio. Lo ideal, entonces, es escribir a medida que vas realizando la tarea que explicas y también evitarás la omisión de pasos y te asegurarás que el proceso funciona.
4. Elementos accesorios opcionales. Si lo crees conveniente puedes incluir elementos como:
• La numeración de los pasos ayuda, pues sirve para la comprensión y la estructuración del tutorial. A ti te obliga a seguir un orden y al lector a leer sin saltearse nada. Además, numerando puedes hacer referencia a puntos anteriores (por ej,: “Cómo vimos en el paso 5”) o evitar al usuario leer pasos irrelevantes, en caso que cumpla alguna condición (por ej.: “Si ya tienes instalado el códec, pasa al Paso 12”).
• Las imágenes Recuerda que “una imagen dice más que mil palabras”, y más en el caso de los tutoriales. Hay procesos que son complicadísimos de describir, pero que con mostrar una imagen quedan ilustrados a la perfección. Tú te ahorras trabajo y los lectores esfuerzo y frustración. Idealmente, cada uno de los pasos debería contar con una imagen de ejemplo, salvo que sean redundantes. Si las imágenes son complejas, deben tener marcadas las partes a las que debe prestar atención.
• Los ejemplos. Si crees que algún concepto es difícil de entender, usa ejemplos sencillos que todo el mundo pueda entender.
4. Relee, rehace y reescribe. Te sorprenderá ver la cantidad de errores que tendrá tu tutorial cuando lo termines. Sea porque lo escribiste deprisa y corriendo o sea porque  no lo has estructurado correctamente, la mayoría de las veces nunca es perfecto en la primera escritura. Si tienes dudas sobre la efectividad de la guía, pásasela a algún conocido que nunca haya realizado la tarea que enseñas para que te dé su opinión. Si no tienes a nadie que te ayude, síguelo tú, palabra por palabra. Si debes hacer algo que no esté escrito, deberás agregarlo. Así de simple.

Bibliografía: Max Ferzzola de http://www.neoteo.com