Cómo escribir un tutorial

Haz que sea corto y simple. Evita usar palabras grandilocuentes o explayarte en cuestiones irrelevantes. Debes tener cuidado de que el lector pueda leer el tutorial por encima rápidamente y captar el sentido.^[4]

• Por ejemplo, al escribir un tutorial sobre cómo limpiar una mancha, tan solo debes decir "Aplica detergente lavavajillas al trapo" sin dar el nombre químico del tipo de detergente ni incluir una lista de otros detergentes y las razones por las cuales no funcionen tan bien.

Describe bien cada uno de los pasos. No escatimes con los detalles, sino más bien describe cada paso con la mayor claridad y precisión posible sin dejar nada para la imaginación.^[5]

Escribe las instrucciones con un tono amistoso. Imagina que conversas con un amigo. No debes sonar como si le hablaras al lector de forma paternalista o como si te consideraras más inteligente que él. La escritura debe parecer natural, como lo que dirías en voz alta si hablaras con alguien.^[6]

• En lugar de decir algo como "Enumera las observaciones tanto analíticas como temáticas en trozos adyacentes del texto", puedes escribir "Escribe notas útiles en el margen".

Da crédito a tus fuentes. En algunos casos, es posible que el material que emplees en el tutorial esté protegido por derechos de autor. En caso de que uses imágenes, información u otros materiales que provengan de otras fuentes, será necesario que les des crédito. Si no lo haces, podrías estar infringiendo las leyes de derechos de autor, por no hablar de las implicancias éticas de llevarte el crédito por el trabajo, las imágenes o las ideas de otra persona.

Incluye imágenes o videos. Si incluyes imágenes o videos en los que se muestre lo que haces, tus instrucciones serán mucho más fáciles de seguir. Con frecuencia, las capturas de pantalla constituyen buenas ilustraciones. Debes tratar de que haya una en cada paso.

• Puedes tomar capturas de pantalla presionando "Impr Pant" y "Ctrl". Luego, puedes usar un programa de edición de fotos como Photoshop o Gimp para que la imagen quede más limpia. Con algunos programas, podrás escribir más instrucciones en la imagen en sí, lo cual te permitirá, por ejemplo, señalar un botón en particular que el lector deba presionar.^[7]
• Para grabar un video, puedes usar un programa como Camtasia o uno de código abierto como Camstudio.
• En caso de que vayas a filmar un tutorial en video, el público debe ver más que solamente tu rostro. Debes incluir también capturas de pantalla, fotografías o imágenes en las que aparezcas llevando a cabo físicamente la tarea. Esto ayudará a que los espectadores conceptualicen el proceso.^[8]

Brinda más de un método. Es recomendable que incluyas diversas formas en las que se pueda hacer algo para que así los lectores tengan más opciones en caso de que tengan dificultades con un método.

Brinda ejemplos. En el caso de los temas menos concretos, quizás sea importante que des ejemplos para que así lo que digas quede más claro. Sin embargo, debes evitar sobrecargar el artículo con ejemplos de forma que quede largo y voluminoso.

• Por ejemplo, si vas a escribir un tutorial sobre cómo presentarte a personas nuevas, podrías brindar diversos ejemplos de cosas específicas para romper el hielo que podrías decir.

Explica las razones por las cuales el tema sea importante. Es más probable que una persona lea tu tutorial si sabe qué es lo que este hará por ella. Debes explicar en la introducción cuáles son los beneficios de aprender esta habilidad. Por ejemplo, si vas a explicar un programa de procesamiento de fotos, puedes informarle al lector sobre algunas cosas divertidas que sea posible hacer con las fotografías.^[9]

Elige un lugar tranquilo para grabar los tutoriales en video. En caso de que vayas a llevar a cabo un tutorial en video, debes tener cuidado de grabarlo en un lugar en donde no haya muchas distracciones. Lo ideal es en un sótano que esté muy lejos del ruido del tráfico.^[10]

Habla con claridad y lentitud. En el caso de los tutoriales de audio y visuales, es importante que no hables con rapidez, ya que será más fácil que los espectadores te entiendan mientras más lento hables. Debes pronunciar las palabras con claridad.^[11]

Escribe el título. Este debe describir con claridad de qué trata el tutorial, así como también ser breve y preciso.

• Considera el siguiente título: "Cómo insertar números de página en Microsoft Word". Omitir las palabras "Microsoft Word" no sería lo suficientemente preciso, ya que el lector no sabría con qué programa trabajaste.
• Considera el siguiente título: "Cómo insertar notas al pie, notas al final, referencias y citas en Microsoft Word". Tanto las notas al pie como las notas al final constituyen tipos de referencias, por lo que se las puede llamar simplemente "referencias". Entonces, si quieres que el título sea breve, podrías escribir "Cómo insertar referencias en Microsoft Word".

Escribe la introducción. Debes escribir un párrafo corto en el que le informes al lector con claridad de aquello sobre lo que vayas a escribir. Debes explicarle las razones por las que el tema será útil y tratar de hacer que el lector se sienta entusiasmado al respecto.

• Quizás te sea útil colocar una imagen del producto final al término de la introducción. Es más probable que el lector se entusiasme por el tutorial si le brindas alguna idea de aquello hacia lo cual vaya a trabajar.^[12]

Redacta los pasos. Cada uno de ellos debe ser claro y breve, y debes esforzarte por que todos tengan una imagen ilustrativa. No debes dejar nada para la imaginación.

Divide los pasos que sean complicados. En caso de que consideres que un paso sea demasiado largo o complicado, podrías preguntarte si lo mejor no sería dividirlo en dos pasos. Debe ser posible que resumas la esencia de cada paso en una sola oración. Es más recomendable que haya muchos pasos cortos que uno largo.^[13]

Practica lo que predicas. Al terminar, trata de seguir tu propio tutorial llevando a cabo cada uno de los pasos. Considera si debes hacer algo para terminar el proyecto que no figure en el tutorial y, de ser el caso, incorpora ese paso.

Escribe una sección de preguntas frecuentes. Esta puede constituir una excelente forma de incorporar una mayor cantidad de información sin que se interrumpa el flujo de los pasos. Toma en cuenta si es que algún término o tema que se haya discutido en el tutorial podría no ser obvio para todos los lectores y, de ser el caso, podrías hablar sobre ellos en la sección de preguntas frecuentes.

• Por ejemplo, en caso de que la tarea involucre el uso de un programa de computadora con el que quizás el lector no esté familiarizado, podrías informarle en la sección de preguntas frecuentes sobre el lugar en donde pueda descargarlo.^[14]

Sigue el mismo bosquejo para los tutoriales en video. Es necesario que tengas un borrador escrito incluso si vas a grabar un tutorial en video, ya que, si improvisas, es probable que te vayas por las ramas. Debes incluir una introducción y varios pasos claramente definidos, al igual que en un tutorial escrito. Asimismo, podrías incluir una conclusión en la que resumas los problemas o expliques las preguntas que podría tener el público.^[15]

Considera el público al momento de revisar el tutorial. ¿Quién es el público? ¿El tutorial está dirigido a principiantes o usuarios avanzados? Piensa también en la información adicional que podría ser necesaria para que el público comprenda el tutorial.

Vuelve a leer y edita el tutorial. Incluso los mejores escritores tienen que leer algo varias veces para así poder detectar todos los errores. Podrías distanciarte del tutorial durante unos días y luego volver a leerlo. De esta forma, lo revisarás con nuevos ojos.^[16]

• Revisa lo básico, como la gramática y la ortografía, asegurándote también de que el tutorial tenga un flujo lógico y sea fácil de comprender.
• Asimismo, podrías pedirle a otra persona que lea el tutorial para ver si le es posible detectar los errores de tecleo, así como también podrá decirte si es necesario añadirle algo más al tutorial para que quede más claro.

Publica el tutorial. Podría publicarlo en tu propio sitio web, en wikiHow o en tu blog. En caso de que hayas elaborado un tutorial en video, podrías subirlo a YouTube.