Quien programe computadoras probablemente ha tenido en ocasiones problemas con la documentación de las rutinas que usa. Muchas veces los manuales para los programadores pueden ser muy oscuros y, cuando ocurre un error, aunque el sistema muestre lo que supuestamente falló, nos quedamos en las mismas.
De hecho, algunos errores en las ventanas azules de la muerte de Windows son muy crípticos y la razón es que pretenden dar información a los programadores de este sistema operativo más que ayudar al usuario con la dificultad.
Pero más allá de estos ejemplos, es claro que muchas veces la documentación del software deja mucho que desear, y por ello la iniciativa de “Stack Overflow” parece ser una buena idea para paliar con este problema. Proponen un nuevo sitio web, el cual está aún en fase beta, que permite a los programadores crear documentación de referencia e incluso con carácter instructivo, de muchas tecnologías de programación.
Esto, de acuerdo con el mismo sitio, Stack Overflow es un manual en la web escrito por desarrolladores y en el sitio se indica: “Complementamos y mejoramos la documentación técnica existente colocando los manuales de instrucciones en recursos vivos que los desarrolladores pueden actualizar en tiempo real con nuevos casos que se les presenten, con implementaciones e integraciones”.
La idea me parece estupenda pues pretende ayudar a combatir uno de los retos más grandes en el mundo de la programación, identificada en el 2016 en la encuesta global que hizo Stack Overflow, es decir, la “documentación pobre”.
Stack Overflow ha reclutado a desarrolladores de muchas compañías, como Microsoft, Xamarin, PayPal, Meteor y DropBox, para que participen. Se espera que otras compañías contribuyan en el futuro poniendo sus manuales de sus tecnologías en el sitio de Stack Overflow.
La documentación del sitio está organizada con cerca de 50 mil etiquetas a partir del sitio de preguntas y respuestas de Stack Overflow, quien ya podrán identificar muchos como un sitio de programadores y para programadores. Para cada etiqueta (tag) la documentación se organiza en tópicos que contienen ejemplos explicando cada tema, seguido de la sintaxis, los parámetros y la sección de comentarios.
El sitio depende de la colaboración de los autores en donde incluso los borradores pueden ser compartidos, proponiendo cambios e invitando a otros a trabajar en el mismo material. Hay un sistema de votos que permite saber qué ejemplos son más populares. La idea es que el sistema haga que los que colaboran consigan puntos, como en el sitio de preguntas y respuestas de Stack Overflow, el cual a la larga da estímulos, premios promocionales, etcétera.
Habrá que ver si la idea tiene éxito y si los desarrolladores se ven motivados a colaborar como lo hacen en el sistema de preguntas y respuestas, aunque claramente no es lo mismo tratar de responder a una pregunta de programación a tener que redactar secciones de algún manual, pero tal vez con los estímulos adecuados, el sitio pueda ser un éxito.
Referencias: i-programmer