Micaela 17 de octubre de 2009 a las 17.34
   Imprimir artículo
elWebmaster.com

Tips para redactar un buen tutorial en tu sitio web


help1Al escribir un tutorial, deberás tener en cuenta algunas consideraciones más que en las que usualmente piensas a la hora de escribir un artículo tradicional.

Los lectores deben seguir pasos, leer código, visualizar demos o examinar imágenes. En esta nota te daremos algunos tips para hacer más eficientes tus tutoriales.

1. Hazlo breve pero directo

Seamos honestos, muy pocos lectores van a leer el tutorial completo. Como con cualquier contenido web, analizar√°n el contenido en lugar de leerlo. S√≥lo si encuentran inter√©s en lo que est√°s mostrando es que lo van a leer. Evita los p√°rrafos largos y las serie de p√°rrafos sin fragmentos de c√≥digo o de im√°genes. Tambi√©n evita describir cada peque√Īa cosa que el usuario debe hacer, sino m√°s bien muestra los puntos clave en el camino hacia la realizaci√≥n del tutorial. Sin embargo, no debes omitir nada importante. Por ejemplo, es importante explicar c√≥mo un elemento ser√° animado con jQuery, pero es completamente innecesario explicar y mostrar la estructura de cada l√≠nea de c√≥digo HTML o CSS usado en el Tutorial.

2. Explica cada tarea de forma corta

Debes ser capaz de explicar cada tarea en unas pocas frases sencillas. Einstein dijo: “Si no lo puedes explicar simplemente, no lo entendiste lo bastante bien”. Imagina lo que piensan los lectores de tu conocimiento del tema y la forma en que lo entender√≠an. Si lo has hecho demasiado largo, vuelve atr√°s y reescr√≠belo.

3. Sepáralo en pasos lógicos

Esto ayudar√° a los usuarios a leer y seguir el tutorial con m√°s facilidad, y volver a un paso espec√≠fico, si lo necesitan. Cada paso debe contener varias tareas despu√©s de las que lector podr√° ver realmente alg√ļn resultado.

33

4. Incluye código pero no lo sobrecargues

Si tienes código para mostrar, hazlo, pero no pegues el demo completo en el tutorial. Nadie va a estar interesados en leer pantallas de código. Muestra sólo los fragmentos clave. Los lectores que estén interesados en el código completo echarán un vistazo a la demo o descargarán el código fuente. Lo que nos lleva a la siguiente sugerencia.

5. Provee demos

Siempre intenta poner demos a disposición de los usuarios. Muchos de los usuarios ven primero el demo y si les interesa, siguen leyendo el tutorial. No te olvides de poner un link al tutorial en cada página del demo para que los usuarios puedan volver a éste con facilidad.

53

6. Visualiza las tareas m√°s complejas

También puedes proporcionar imágenes que expliquen las tareas más complejas o pasos a seguir. Cuando los lectores ven una demostración, entenderán cómo funciona, pero se entiende cómo se hace solamente si leen la demo o ven la imagen explicando el proceso de creación. Estas imágenes también ayudan a los lectores a visualizar algunos pasos o el tutorial completo.

6

7. Siempre brinda código fuente

A algunos lectores les gustaría tener el código del tutorial disponible offline. De esta manera pueden examinar el código, incluso si no son capaces de acceder a su tutorial por cualquier razón. Debes comprimir los archivos y dar un nombre significativo al archivo comprimido. Lo mismo se aplica a todos los demás archivos. También deberías incluir un enlace al tutorial en sus páginas de demostración para que el lector pueda volver fácilmente si es necesario.

8. Pon los links de descarga y demos en lugar prominentes

Este es uno de los aspectos m√°s importantes. Es importante colocar el demo al principio del art√≠culo y de forma prominente. La posici√≥n es usual es debajo de una peque√Īa introducci√≥n y/o¬† imagen pero antes del primer paso del tutorial. Hemos probado 3 versiones diferentes del mismo tutorial:

* Tutorial con un link de demo prominente en la parte superior del mismo.

* Tutorial con un link plano al demo en la parte superior.

* Tutorial con un link a la p√°gina demo colocado al final del mismo.

La primera versión es la que mejores resultados tuvo.

9. Únete a la discusión

Una vez que publicas el tutorial tu trabajo no termina. Los lectores tendrán diferentes opiniones sobre éste, puede que lo critiquen o que hagan sugerencias. Contesta los comentarios. Así, les mostrarás a los usuarios que te importa su opinión y que tus tutoriales están ahí realmente para ayudar.

10. Actualiza el tutorial si es necesario

Si te equivocaste en algo, o si alguien realiza una mejora, modifica tu tutorial. Esto lograr√° satisfacer a los usuarios que han notado alguna falla y motivar√° a otros a leer tus tutoriales y comentar acerca de ellos.

¬ŅQu√© esperas para crear tus propios tutoriales?

Fuente: Janko at Warp Speed


Enviar a Del.icio.us Enviar a Meneame Enviar a Digg Enviar a Fresqui Enviar a Enchilame

Comentarios (1)

  1. N√©stor An√≠bal Torres √Ālvarez dice:

    Guayaquil, 20 de octubre del 2009

    Las recomendaciones establecidas son valiosas, pero par que surtan un fecto positivo hay que aplicarlas y mejorarlas, por que es así como se avanza, ya que los parámetros están dados, el individuo en sí en innovador, porque su propia naturaleza le impone.

    felicitaciones

Deja tu opinión

© 2007 - 2008 elWebmaster.com | Powered by Wordpress | Diseño CSS y XHTML válido. | Algunos íconos basados en FamFamFam Mini
Acceder