Un tutorial para escribir tutoriales

Esta es una guía para escribir tutoriales para la web en donde podras observar las secciones básicas que debe contener un tutorial.

Esta guía no es definitiva, puedes agregar o eliminar secciones, todo depende del tema y el nivel de profundidad que desees en el tutorial.

El titulo

Para escribir un tutorial es importante empezar con el titulo, este debe ser claro pero a la vez especifico. Esto le da una idea al lector y le ayuda a definir si el contenido le sirve o no. Además permite a los buscados indexar bien tu tutorial.

No escribas: Efecto de nieve.
Mejor escribe: Efecto de nieve en Flash con Actionscript.

Hay tantos efectos de nieve como aplicaciones de animación y edición de imágenes, por lo que es mejor ser especifico.

Descripción

El titulo fue la primera descripción, pero adicionalmente debes escribir una pequeña introducción al principio del tutorial. En ella debes ser más especifico que en el titulo y explicar bien cual sera el resultado al finalizar el tutorial.

Para escribir la descripción puedes guiarte por estas preguntas:

  • ¿Que voy a explicar?
  • ¿Que herramientas voy a utilizar?
  • ¿Desde que punto de vista?
  • ¿Cual sera el resultado?

Por ejemplo: Si haces un tutorial sobre páginas web es necesario explicar de que tipo  son estas (estáticas, dinámicas, etc.), con que herramienta(Notepad, Dreamweaver, etc.), desde que punto de vista(Diseño gráfico, programación, usabilidad, etc.) y cual sera el resultado(Un sitio web agradable visualmente y fácil de usar).

Herramientas

Aquí hacemos un listado de todas las herramientas que necesitaremos para obtener el mismo resultado. Si es posible indica como obtenerlas.

Si es software detalla la versión y el sistema operativo. Si es madera explica indica el tipo de árbol. Y así sucesivamente.

Instrucciones

Lucete, demuestra lo que sabes, en esta parte tu eres el experto.

Solo ten en cuenta que el lector es inexperto(la mayoría de las veces) y necesita que le expliquen claramente. En muchas ocasiones nunca ha visto o usado la herramienta.

Explica claramente todos los procedimientos, por que hiciste esto o aquello. Incluye imágenes y teclas abreviadas, si es posible agrega consejos, trucos u otras formas de lograr el mismo resultado.

No escribas: Guarda el espacio de trabajo y  luego ejecuta X.
Mejor escribe: Selecciona el menú de Archivo y haz click en Guardar espacio de trabajo(Ctrl+Shift+G), de esta manera podremos ejecutar X y no perder la información.

Los resultados, ejemplos y pruebas

Al finalizar las instrucciones es importante mostrar el resultado con imágenes y una explicación detallada de lo que obtendremos.

Si es información digital proporciona ejemplos descargables para que el usuario compare resultados, recuerda que los ejemplos son la mejor manera de aprender, el tutorial es solo una explicación del ejemplo.

Si es un ejemplo complejo explica como probarlo y cuando saber que esta listo.

Ayuda extra

Muy probablemente el tutorial no abarca todo lo necesario, lo cual no es malo, solo es importante que ofrezcas referencias y enlaces hacia otros tutoriales relacionados.

La importancia de estas referencias es que ofreces al lector un camino para seguir aprendiendo o para obtener un mejor resultado(tal vez no quiera nieve sino lluvia).

Además incluye que información encontrara en cada referencia, por ejemplo:

  • Visita X para ver más ejemplos.
  • Visita Y para informarte sobre los estándares.
  • Descarga el programa Z para realizar las pruebas.

Dudas, comentarios y sugerencias

No olvides colocar una sección en donde el lector pueda resolver sus dudas, que comente o escriba sugerencias.

Piensa que dudas se pueden presentar y anticipate con la respuesta.

Confianza y comodidad

Haz que el tutorial sea confiable y cómodo de leer. Recuerda que un tutorial bien escrito es muy agradable de leer.

Para lograrlo guiate por estos sencillos consejos:

  • Manten buena ortografía y redacción. Un tutorial con faltas de ortografía es incomodo de leer y nos hace dudar acerca del autor.
  • Si utilizas terminos técnicos procura explicarlos.
  • Las imágenes apoyan mucho tu explicación además de reforzar la confianza del lector(puede ver que funciona).
  • Separa el texto en párrafos pequeños, evita bloques enormes de texto, usa viñetas(listas), subtitulos y si es posible color.
  • Imprime tu estilo en el tutorial, esto lo hara más agradable a tus lectores.
  • Ofrece el tutorial para descargar(si deseas) y de preferencia en formatos estándar(txt, html, pdf, etc.)
  • Al final del tutorial debes colocar tu nombre y una breve descripción de tu cargo o habilidades, no lo hagas por vanidad, hazlo para certificar con tu firma el contenido del tutorial

Comparte y respeta la información

Comparte tu conocimiento con los demas, no limites la información, publicala bajo licencias gratuitas como Creative Commons. Permite que otros utilicen, compartan y amplien el tutorial.

Si modificas, publicas o utilizas material de otro autor respeta la licencia, si carece de esta contacta con el autor. Que sea gratuito no quiere decir que no tenga dueño.

Las licencias Creative Commons estan diseñadas para ofrecer contenido gratuito. Los requisitos dependen del tipo de licencia, en este caso el tutorial se encuentra bajo licencia Creative Commons 2.5 Atribución-NoComercial-Igualar, lo que significa que puedes usarlo siempre y cuando indiques el autor, no lo vendas o negocies y si si lo utilizas para crear un nuevo documento debes utilizar la misma licencia.

Eso es todo(por ahora), espero tus comentarios, dudas o sugerencias.