La nueva herramienta documental de StackOverflow convierte el ejemplo en protagonista

Documentation, la nueva herramienta documental de StackOverflow, busca extender el mecanismo de preguntas y respuestas que popularizó el sitio web al terreno de la redacción técnica. Esta fórmula, de por sí innovadora, resulta aún más atractiva al convertir los ejemplos en protagonistas de cada artículo, relegando a un segundo plano el desarrollo teórico de cada concepto.

Preguntas, respuestas… y documentos

StackOverflow presentó esta semana Documentation, definida en el propio blog del sitio web como el mayor cambio de la plataforma desde su lanzamiento. StackOverflow fue fundado en el año 2008 para expandir el conocimiento de los desarrolladores, independientemente de cuál fuese su lenguaje de programación. Este sitio web adquirió notoriedad rápidamente gracias a un sistema de preguntas y respuestas por el que las respuestas más útiles son votadas por la comunidad, consiguiendo que destaquen sobre aquellas menos útiles. A este sistema de clasificación por votos, se añade además un componente de ludificación basado en puntos de reputación que se otorgan a los usuarios más activos y con mayor número de votos positivos. Desde su fundación, millones de desarrolladores -y no desarrolladores- se han beneficiado de esta plataforma para resolver sus dudas.


Este mecanismo de preguntas y respuestas ha mejorado progresivamente, convirtiéndose en el modelo de referencia para muchos otros sitios web. Pero este planteamiento tiene también sus limitaciones. Una de ellas es que las preguntas tienden a ser muy específicas, o relativas a problemas de programación muy concretos, dejando de lado cuestiones de carácter más general, que son sobre todo comunes entre los principiantes. De hecho, muchas preguntas son rápidamente moderadas -descartadas- por ser demasiado genéricas. La nueva herramienta de documentación busca poner fin a esta limitación, sirviendo de base para tratar un contenido de carácter más académico y, por definición, con un alcance más extenso.

Documentation da cabida a una gran cantidad de buen contenido que ha sido rechazado, o que es difícil de “hacer bien” en el formato de preguntas y respuestas. A saber, la referencia aceptada, general, el contenido didáctico.

Mostrar mejor que contar

Pero, ¿qué hace del planteamiento de StackOverflow algo novedoso cuando se compara con otras plataformas documentales? Desde un punto de vista puramente formal, Documentation podría pasar por otra wiki en la que el contenido se desarrolla con la participación conjunta de diferentes personas. Lejos de ser así, la fórmula de StackOverflow es radicalmente diferenciadora.

Por un lado, el modelo de preguntas y respuestas se traslada ahora al terreno de la documentación técnica, de manera que los artículos con más votos positivos prevalecen sobre los menos votados. En la práctica, esto se traduce en que los artículos y ejemplos más útiles destacan sobre el resto y pasan a convertirse así en comúnmente aceptados. De esta forma, la autoridad del redactor técnico sobre un tema queda relegada a la suma de decisiones de la comunidad, que es finalmente quién evalúa qué contenido es útil y cuál no lo es. Este modelo de desarrollo no es tanto una colaboración de diferentes partes -como sucede con una wiki-, sino la competencia de esas partes, a través del sistema de votos, por proporcionar el mejor contenido.

Juntos, creemos que podemos hacer lo mismo para la documentación técnica que lo que hicimos para las preguntas y respuestas

Por otro lado, situar el ejemplo como elementos principal del artículo supone romper con el modelo clásico de documentación técnica, donde estos ejemplos quedan subordinados al desarrollo teórico de cada concepto. Los ejemplos dejan de ser así meros elementos de apoyo. Se enfatiza además la necesidad de que cada artículo de Documentation contenga varios ejemplos, y que estos, de la misma forma que se hace con el formato de preguntas y respuestas, puedan ser votados.


Este tratamiento de los ejemplos es innovador, pero al mismo tiempo lógico en lo que a documentación técnica se refiere. En la mayoría de las ocasiones, un ejemplo ilustra mucho mejor cómo usar una funcionalidad del código que una exposición teórica sobre esa funcionalidad. Sin embargo, es dudoso que este planteamiento sea también el más adecuado en documentación técnica no destinada a desarrolladores, donde las explicaciones son esenciales para que el usuario entienda las tareas que ha de completar.

A esta iniciativa se unen ya otros desarrolladores como Microsoft, que participarán aportando y revisando el contenido, y usando ese contenido para ampliar su propia documentación. La propuesta de StackOverflow está en sintonía con los cambios anunciados recientemente por Microsoft, con una clara tendencia a situar los ejemplos y tutoriales como ejes de la documentación técnica.

Iniciativas como la llevada a cabo por StackOverflow, de alguna forma, ponen también en cuestión el extenso sector editorial de los libros de aprendizaje para programadores. De igual forma que el modelo libre y colaborativo de Wikipedia puso fin a las tradicionales enciclopedias, el desarrollo de un modelo de documentación libre y colaborativo, puede también suponer el final de una buena parte de este sector. Si el punto de partida para aprender un lenguaje de programación hace tan solo unos años pasaba por la la compra de uno o más libros, la tendencia hoy parece inclinarse por aprender a través del conocimiento compartido por otros, y el uso extensivo de tutoriales (ejemplos, al fin y al cabo) como base del aprendizaje.

Documentation, aún en fase beta, incluye ya una gran cantidad de artículos [link:http://stackoverflow.com/documentation] tan solo unos días después de su lanzamiento, lo que demuestra el enorme interés de la comunidad de desarrolladores por participar de esta idea y compartir su conocimiento más allá del modelo de preguntas y respuestas.

(este artículo fue publicado originalmente en LinkedIn el 24 de Julio de 2016)