[Miguel]

Como hacer un tutorial

Introducciуn

De momento a momento veo gente en este foro redactando tutoriales malos, asн que escribo esto como una guнa para esas personas.

Por favor, tomen en cuenta que no estoy tratando de desalentar a nadie para que no haga tutoriales, solo trato de explicar como se debe redactar correctamente.

Problemas

• Autoridad

Si tu escribes un tutorial, los lectores asumirбn que tu sabes de lo que estбs hablando - їpara quй hacer todo un tutorial acerca de algo que no sabes? Si alguien hace algo de una manera diferente a la que normalmente usarнan, muy raramente comprueban de cual manera es mejor, esa persona simplemente asume que de la manera que estб puesto todo en el tutorial es como se hace todo, solo porque es un tutorial!

Por esa razуn, si escribes un tutorial, efectivamente estarбs dando a entender que tu tienes conocimiento en ese tema y estбs calificado para escribir del mismo.

• No es un debate

En un tema normalmente se hacen preguntas, si pones una soluciуn a un problema, mбs adelante otros pensarбn que tienen una soluciуn mejor y por consiguiente la expresarбn, sin importar si hay una discusiуn o nу.

En un tutorial las personas asumirбn que la forma de que tu haces lo que se estб hablando en el mismo es la correcta, tu no haces tutoriales para enseсar algo que no estб bien hecho (aunque aquн lo hacen, pero eso es lo que estoy tratando de detener). Muy raramente alguien preguntarб por informaciуn en un tutorial.

• Metodos

Hay un gran problema en esta comunidad y es la mala propagaciуn de informaciуn. Tomarй dos ejemplos comunes - 256 y strtok. En los primeros dнas de SA-MP, estos metodos eran muy comunes y aceptados, hicieron lo que tenнan que hacer y nadie sabнa una mejor forma de hacerlo lo que los mismo lograban. Mientras el tiempo pasу, algunas personas desarrollaron mejores metodos (conocidos como dcmd/sscanf, matrices mбs pequeсas, etc.), їlo que significarнa que los viejos metodos serнa dejados atrбs? ЎPuйs no pasу!

Solamente porque muchas personas seguнan utilizando estos viejos metodos en sus scripts (actualizarlos es mucho trabajo por lo que dejarlos asн como estan es mбs que suficiente) se siguiу enseсando estos metodos a las personas que entraban nuevas a SA-MP, los cuales tambiйn enseсaron a mбs personas. Si sabes que el metodo que estбs utilizando no es el mбs moderno o actualizado, їpara quй molestarse en publicar el tutorial? O explicas la mejor manera de hacer las cosas, independiente si usas el metodo moderno o nу, Ўo simplemente no publiques el tutorial!

• Remarcando errores

Por las razones que acabo de mencionar, trato de leer todos los tutoriales publicados y si encuentro algo que sй que no es correcto, les llamarй la atenciуn remarcando el error.

Si publicas algo, estarбs directamente diciendole al mundo que sabes algo, por lo que si alguien logra mostrar a todos que la informaciуn que estбs dando es incorrecta, se podrнa decir que nunca debiste hacer el tutorial, en primer lugar. Muy pocas personas remarcan los errores en la informaciуn de un tutorial, lo cual es una pena, honestamente me gustarнa que lo hicieran con mis tutoriales.

Investigar

Esto parece que es lo que mбs falta cuando alguien escribe un tutorial - si vas a decirle a alguien como hacer algo, la primera cosa que debes preguntarte tu mismo es si pudieras hacer tu mismo de una mejor forma. Solo porque ese metodo, lo has utilizado por muchos aсos y nunca a fallado, no significa que sea la mejor forma de hacer lo que se quiere.

Si estбs publicando una funciуn - revisala bien, revisa la literatura en la misma, ve si hay alguna implementaciуn que puedas hacer. Si tienes mбs de una versiуn de la funciуn, cronomйtralas y ve cual esa mбs tiempo para ejecutarse, cual usa mбs recursos, etc. Esto puede significar que tengas que alterar el tutorial, їpero quй importa? Significa que los lectores estбn aprendiendo una mejor manera de hacer esa funciуn, lo cual, en primer lugar, es el punto de hacer un tutorial (enseсar cuales son las mejores maneras de hacer algo).

Explicaciones

Aquellos tutoriales que simplemente dicen "has esto, despuйs esto y despuйs aquello y todo estarб listo" son estupidos. Algunas personas pueden solo querer instrucciones de como hacer algo paso por paso, pero otros querrбn saber POR QUE se hace tal cosa. Escribe la guнa estilo paso por paso en el tope del tema, pero despuйs agrega explicaciones mбs abajo. Aquellos que se preguntan y encuentran POR QUE se hacen las cosas y no como hacerlas, son los que tienen mбs posibilidad de ser buenos en lo que hacen (codificar).

Al explicar porque se hacen las cosas de cierta forma, estarбs dandole la ventaja al lector de PODER decidir cuando mejorar, usar, o no usar tu metodo.

Presentaciуn

Esto es bastante importante, aunque no es mi punto fuerte, asн que no escribirй mucho acerca de esto.

Solo asegurate de que este ordenado y en secciones cortas, si es posible. Me doy cuenta de que este tutorial estб basado en puro texto, por lo que no es el mejor ejemplo para este punto, pero trata de romper esos grandes parrafos y sustituirlos por bloques de texto pequeсos. A nadie le gusta leer parrafos largos.

Tambiйn es importante donde pongas el tutorial. Normalmente dirнa que lo pongas en la wiki, pero puede depender del caso. Y si es acerca de un simple modo o include, ponlo en el tema correcto, ya sabes cuales son las reglas hacerca de los lanzamientos y sus temas.

Una introducciуn y conclusiуn tambiйn tienden a ser buenas.

Desinformaciуn

Solo quiero remarcar este punto nuevamente - asegurate de que lo que estйs enseсando este entre las lineas de lo actualmente utilizado. Si tienes un comando, usa dcmd (o zcmd actualmente), si necesitas una matriz, calcula cuanto espacio necesitas en la misma, etc.

Tambiйn asegurate de que lo que estes diciendo sea tan bueno como se pone, puede ser mejorado en adelante pero tambiйn que NO HALLA SIDO MEJORADO EN EL PASADO.

Conclusion

Investiga hacerca de tu artнculo y recuerda, si publicas informaciуn mala yo, y ojala otros te llamaremos la atenciуn y te haremos parecer un tonto.

Originalmente creado y redactado por ******, al igual que ha sido traducido y publicado en esta secciуn con su permiso.

Original: https://sampforum.blast.hk/showthread.php?tid=65567