Cómo escribir un tutorial

Puede parecer simple. Tú sabes que lo sabes y crees que con saberlo debería bastar. Pero hasta el más genio de los genios puede encontrarse ante la imposibilidad de trasmitir sus conocimientos. ¡Les pasa a los mejores, no te preocupes! Es que un tutorial se debe escribir para un lector con escasos conocimientos y, por lo tanto, responde a una dinámica de escritura muy pormenorizada, que debe seguir una estructura lineal, clara y concisa. ¿Necesitas un tutorial de cómo escribir tutoriales? Aquí tienes uno.

¿Qué es un tutorial?
Antes de comenzar, es necesario aclarar el punto más importante de todo este artículo. Si no sabemos lo que hacemos, no sabemos hacerlo. Por eso, es imprescindible saber qué es y qué no es un tutorial. Veamos.

Un tutorial es una serie de instrucciones conectadas, una guía paso a paso, que busca enseñar una, y solo una, tarea. Debe tener todo lo necesario para que el objetivo se pueda completar con éxito y el usuario llegue al final con una solución a su problema, inquietud o necesidad.

Es importante notar que un tutorial no es un manual (o curso). Un manual enseña el uso general de un programa, no una acción específica dentro del mismo. Por ejemplo, en este tutorial enseñamos cómo utilizar Photoshop para remover imperfecciones de la piel. No es un manual sobre Photoshop, sino de una de las tantas cosas que se pueden hacer con él. Lo mismo sucede con este tutorial. Guía a los usuarios a armar un medidor de tensión, no enseña electrónica en general.

Para que se entienda mejor: los manuales o cursos son una serie de tutoriales conectados que pasean al usuario por todos los aspectos de un programa u oficio, para que aprenda mediante la práctica. ¿Lo quieres más claro todavía? Esto es un tutorial. Esta es la primera parte de un curso.

La preproducción

1) ¿Hace falta?
Antes de escribir un tutorial, hazte la siguiente pregunta: ¿es realmente necesario, va a ser de utilidad, va a aportar algo? Ten en cuenta que hoy en día existen programas y servicios de toda clase. Hay muchísimas aplicaciones que automatizan los procesos y hacen las cosas más simples para los usuarios. Por ejemplo, ya de nada sirve explicar cómo conectar un Home Theater cuando existen servicios como WireWize, que lo hacen automáticamente y hasta contemplan las configuraciones de dispositivos de diferentes marcas y modelos. Otro ejemplo, ¿hace falta escribir un tutorial sobre cómo hacer un backup de tus Favoritos de Firefox cuando Foxmarks ya lo hace por nosotros, a diario, manteniendo un backup en línea?

2) Planeamiento
¿Ya sabes lo que quieres enseñar? ¡Perfecto! Pero, ¿sabes cuál es la mejor forma de hacerlo? Cuidado, no todos los tutoriales tienen procesos lineales. Por ejemplo, hacer un tutorial sobre vLite es simple, porque es el programa el que marca el orden y la sucesión del paso a paso. Muy diferente es explicar cómo ver películas en una Nintendo DS. En este caso, el paso a paso no está marcado por ningún software y se necesitan complementos externos para completar la tarea. Cuando sea así, es prioritario planear la estructura. Si no lo haces, la hoja en blanco podría ser tu peor enemiga.

3) Herramientas
Antes de comenzar a escribir, asegúrate de tener todas las herramientas que necesitas, más allá de las lógicas que intervienen en la realización del tutorial. Por ejemplo: ¿Necesitas capturas? ¿Debes grabar un vídeo de la pantalla? ¿Tiene batería tu cámara? Parece una tontería, pero escribir es una tarea que requiere concentración. Si debes interrumpir la redacción a cada rato, probablemente demores el triple. Lo que es peor, la frustración hará que precipites tu obra o la termines de mala gana. Y eso siempre se nota.

¿Todo listo? Ya puedes comenzar a escribir.

1) Título y descripción
Un tutorial es una guía que carece de valor literario. Por lo tanto, no es algo se disfrute al leer. Por más didáctico que sea, por más ameno que lo hagas, no deja de ser una utilidad, la descripción de una tarea paso a paso. El título y la descripción deben ser lo suficientemente claros para que el lector determine si desea o no seguir leyendo. Fíjate el título de este mini tutorial: Free Video to MP3 Converter: Extrae MP3 de vídeos. Desde el título ya se establece el programa que se va a utilizar y para qué lo vamos a utilizar. El usuario, con solo leerlo, sabe si le interesa o no.

2) Observaciones
Es importante que antes de comenzar el paso a paso escribas las observaciones que creas convenientes. Este mismo tutorial comenzó con las recomendaciones que creímos eran necesarias hacer. Las observaciones dependen muchísimo sobre lo que escribas. Pueden ser simples consejos, una explicación de los métodos y programas que usarás, enlaces de descargas de programas que se van a utilizar durante el paso a paso, una lista de los “ingredientes” necesarios o una advertencia de los posibles problemas con los que se puede encontrar el lector, entre otras cosas

3) Paso a paso
Todos los tutoriales deben seguir un paso a paso claro y conciso. Sin palabras de más que distraigan la atención del lector. Debes ver la guía como una receta de cocina. Imagina que el usuario está siguiendo el paso a paso mientras hornea un pastel. ¿No querrás que se le queme porque tú no eres claro o usas palabrerío innecesario, verdad?
En la misma línea, no dejes nada librado a la comprensión del lector. La ambigüedad es tu enemiga número uno. Para que esto no suceda, ver Paso 4.

4) Haz, luego escribe
Debes entender que el lector, si está usando un tutorial, es porque no sabe. Así de simple y crudo. Cosas que para ti son obvias, puede que para el lector no. Lo ideal, entonces, es escribir a medida que vas haciendo la tarea que explicas. Así, podrás documentar el paso a paso, sacar capturas, fotos o capturar vídeos. También evitarás la omisión de pasos y te asegurarás que el proceso funciona.

5) Numeración
La numeración también ayuda. Aunque pueda parecer irrelevante, sirve para la comprensión y la estructuración del tutorial. Te obliga a ti 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”).

6) Imágenes, imágenes, imágenes
Como te contamos en el paso 4, debes sacar imágenes del proceso. Eso de que “una imagen dice más que mil palabras” es una verdad universal, y más en el caso de los tutoriales. La escritura tiene sus límites, más cuando queremos mantener las cosas simples. Hay procesos que son complicadísimos de escribir, 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. Las imágenes, si son complejas, deben tener marcadas las partes a las que debe prestar atención.

7) Usa ejemplos
Si crees que algún concepto es difícil de entender, usa ejemplos al alcance de todos. Relee el Paso 3. Seguro que al comparar un tutorial con una receta de cocina, te habrás dado una buena noción de lo que quisimos decir. Si funcionó para ti, funcionará para tus lectores.
Los ejemplos, claro, no siempre pueden resolverse de manera tan simple. Si estamos hablando de cosas más complejas, serán necesarios ejemplos más complejos. Nosotros, en el proyecto EXCEL: Convertir números a letras incluimos una plantilla para que sirva de base para los interesados. Si tu tutorial lo amerita, debes hacer lo mismo.

9) El que mucho abarca, poco aprieta
Nunca intentes enseñar más de una cosa por tutorial. Si para realizar un tutorial con éxito, el usuario necesita realizar tareas previas, que también requieran conocimiento y práctica, es que necesitas hacer dos (o más) tutoriales.
Por ejemplo, este pequeño tutorial para hacer un Módulo de 8 Entradas / Salidas se pudo mantener tan simple porque se enlazó con muchos otros tutoriales escritos con anterioridad. Básicamente, es la puesta en práctica del curso de PIC Modules, del curso Programación de microcontrolares y del tutorial Construcción de circuitos impresos.

Y, por último…

9) Relee, rehace y reescribe
Te sorprenderá ver la cantidad de errores que tendrá tu tutorial cuando lo termines. Sea porque lo escribiste apurado, por pequeñas incongruencias gramaticales o porque sí, 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 hecho la tarea objetivo para que te brinde feedback. Si no tienes nadie que te ayude, síguelo tú, palabra por palabra. Si debes hacer algo que no esté escrito, debes agregarlo. Así de simple.

Y siempre deja un canal de comunicación abierto para las dudas. Aquí, en NeoTeo, por medio de los comentarios, hemos podido resolver muchos de los problemas con los que se encuentran los lectores. Tú deberías hacer lo mismo.

¡Esperamos que haya servido!