DNN Summit 2019


Construyendo una plataforma mejor

Construyendo una plataforma mejor

Ofrecemos la traducción de un interesante artículo de Kelly Ford sobre la importancia de la documentación sobre DNN.

Durante años he escuchado quejas sobre el estado de la documentación de desarrollo de DNN. Es hora de que lo solucionemos de una vez por todas. Voy a encabezar la iniciativa, pero primero permítanme compartir cómo llegué a este punto.

Como ya sabrán, DNN 9.2 incluye una nueva e importante funcionalidad: PROMPT: una interfaz de línea de comandos rápida, amigable y extensible para la Plataforma. Fue votado como la mejor contribución de código abierto en DNN-Connect 2017.

Lo que quizás no sepa es que yo fui quien lo creó (con contribuciones fundamentales por parte de Peter Donker, David Poindexter y Clint Patterson). Menciono esto, no por ser autocomplaciente, sino como una presentación para quienes no me conozcan (esta es mi primera publicación en el blog de DNN) y para poner las cosas en contexto.

PROMPT es mi primera contribución comunitaria. Sin embargo, no será la última porque hace unos días me enviaron este cumplido:

- "No estoy seguro de quién lo hizo, pero la ayuda y la documentación de PROMPT son un gran trabajo, ¡la primera ayuda útil en DNN!"

Es un comentario destacable y me hizo sonreír de oreja a oreja. La documentación suele ser un trabajo ingrato. La única respuesta que recibes suele ser negativa.

Ya ven, soy un firme creyente de que la buena documentación es un componente crítico para el éxito de cualquier aplicación. Por eso dediqué tanto tiempo al sistema de ayuda de PROMPT, tomando la decisión de escribir la documentación en paralelo con el desarrollo, en lugar de hacerlo después.

Así que aquí estaba dándome palmaditas en la espalda ... pero una frase en ese comentario seguía mordiéndome como el Corazón revelador de Poe ...

- "... ¡la primera ayuda útil en DNN!"

Desafortunadamente, esta no es la primera queja que un miembro de la comunidad ha expresado sobre la documentación de DNN. He estado desarrollando para DNN desde la v.1.08 y mi experiencia personal ha sido de frustración con la documentación o sobre su carencia.

Sé que no soy el único con esta sensación. Los desarrolladores pueden pasar horas curioseando a través de publicaciones en el foro, entradas de wiki superficiales y publicaciones de blog relacionadas tangencialmente antes de recurrir a profundizar en el código fuente para encontrar respuestas a sus preguntas.

Déjenme hablar claramente. Elaborar bien la documentación es una grande labor, que requiere mucho trabajo. Cuanto más grande es el proyecto, más difícil es la tarea. Se han realizado muchos esfuerzos a lo largo de los años para mejorar la situación en DNN. Se ha avanzado y el reciente Centro de Documentación es un buen paso en la dirección correcta. Pero hay mucho más por hacer.

La documentación es crucial para el éxito de DNN

Enfrentémonos a los hechos. Si queremos que la plataforma prospere, necesitamos una mayor aceptación por parte de los desarrolladores. La única forma en que eso sucederá es que alguien finalmente tome el toro por los cuernos y cree documentación que facilite a los desarrolladores de DNN, ya sean nuevos o experimentados, la creación de soluciones innovadoras.

Por tanto, me complace anunciar que encabezaré un nuevo esfuerzo de la comunidad para llevar la documentación de DNN al nivel superior. Soy consciente de que quizás me estoy jugando el cuello aquí. Hace un par de párrafos estaba hablando acerca de lo difícil que puede ser la tarea de documentación. Sin embargo, creo realmente que una excelente documentación es fundamental para el éxito de DNN. Espero que estén de acuerdo, y de hecho, quiero que hagan algo más que darme la razón. Voy a necesitar su ayuda.

Esta semana empezaré mi obra reuniéndome con un grupo (deliberadamente) pequeño de personas con una larga trayectoria en la comunidad. Nuestro objetivo es determinar la mejor forma de abordar este problema. Tengo muchas ideas sobre la documentación "ideal" y estoy seguro de que ustedes también. En las próximas semanas publicaré sobre nuestro progreso y solicitaremos su opinión. Puedo garantizarles una cosa. La documentación exitosa es un esfuerzo de toda la comunidad.

Las contribuciones son el alma de un proyecto de código abierto saludable. Tenemos la intención de crear un marco que les permita contribuir para su propio beneficio y el de la comunidad, al igual que contribuí con PROMPT. Si soy el único que trabaja en el proyecto, fracasará; pero juntos podemos construir documentación dirigida por la comunidad que beneficie a todos, atraiga a nuevas personas y haga crecer el ecosistema. Espero que se unan a mí en esta aventura. Permanezcan atentos a este espacio...

454 Puntúe este artículo:
5.0

Deje un comentario

Añadir comentario