Episodio 80: La mejor manera de aprender y mejorar la documentación de una librería

Envíanos tus preguntas aquí https://forms.gle/jWX7r5JSVRaPDztw9

La mejor manera de aprender y mejorar la documentación de una librería - Liga del Código 080

Bienvenidos a la liga del código, un podcast de developers para developers, en este episodio número 80 nos hacen las siguientes preguntas:

1) Actualmente estoy en una nueva área del negocio en lo que es un cambio de carrera (de soporte a desarrollo de software).

He estado en esta posición por poco más de un año, y cuando comencé mi jefe quería que leyera un PDF de 800 páginas en uno de los paquetes de software que usamos principalmente. Después de leerlo, quiere enviarme a un curso y luego obtener la certificación en él, pero no lo hará hasta que lo haya leído y él me haya ‘probado’ en algunos conceptos.

De mi puesto anterior, ya había aprendido mucho sobre este software solo por prueba y error (y challenges), por lo que cuando leo este PDF / Libro, estoy luchando mucho por retener la información. Nunca he podido aprender nada de esta manera, ya que aprendo principalmente haciendo e investigando ciertas cosas en las que me quedo atascado, o de un tutorial.

Mi jefe me ha dicho que necesito leer este libro / PDF y no aceptará un no por respuesta.

¿Cómo le digo que esa no es mi manera de aprender?

2) Tengo una librería open source y me agrada que haya usuarios de mis proyectos.

Sin embargo, de vez en cuando, sucede que algunas personas que definitivamente no están en el público objetivo de mi software intentan usarlo y esperan soporte.

Por ejemplo, estoy desarrollando una biblioteca de software (es decir, una pieza de software reutilizable que no se puede usar por sí sola, pero se usa en aplicaciones para lograr algo) que logra X pero se basa en una librería más grande Y. A veces, obtengo usuarios que quieren lograr X pero no tienen idea de cómo usar Y. Intento enviarlos a usar la librería Z, que logra X sin necesidad de Y, pero no siempre funciona.

En su lugar, comienzan a revisar los ejemplos y la documentación (lo cual es bueno), pero que no están hechos para ser realmente utilizables sin al menos una comprensión básica de cómo funciona Y. Ahora esperan que los ayude con sus problemas con Y, no con sus problemas con mi proyecto.

Creo que esto se debe en parte a que no pueden distinguir los problemas que surgen de su falta de conocimiento sobre Y de los problemas que surgen de su falta de conocimiento sobre mi proyecto (estoy feliz de aceptar y responder preguntas que surjan de este último: porque muestran que mi documentación es insuficiente).

Ahora mi pregunta es: ¿Cómo los envío para que aprendan primero los conceptos básicos sobre sin parecer grosero?

Disfruten!

En este episodio participan:

German Popoter - https://twitter.com/GermanPopoter
Manuel Mejia - https://twitter.com/mejiamanuel57

Youtube: https://youtu.be/d1K4icF04Ao

#opensource #aprendiendo #documentacion