Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Data Commons
- Escritor técnico:
- KilimAnnejaro
- Nombre del proyecto:
- Mejora de la documentación de introducción de DataCommons
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
En mi carrera como ingeniera de software, me sentí frustrada reiteradamente por la experiencia de unirme a un nuevo equipo o proyecto, extraer un repositorio de código, ejecutarlo y ver cómo el software fallaba cuando faltaban pasos clave en la documentación. Enseguida me di cuenta de que podía aplicar mi pasión de toda la vida por la escritura y la composición a estas necesidades mientras creaba un entorno de apoyo para que los desarrolladores con los que trabajé se enfocaran en la innovación técnica y la creatividad, en lugar de resolver problemas con respuestas conocidas.
Esta innovación técnica y creatividad es necesaria con urgencia en muchos segmentos de la sociedad, en especial por líderes del gobierno y del sector de las organizaciones sin fines de lucro que buscan analizar conjuntos de datos en sus espacios problemáticos. Al hacer que estos datos estén disponibles como servicio, DataCommons reduce la barrera de entrada para los analistas que buscan datos de fácil acceso y cercanos al formato que necesitan para sus funciones. Para ello, DataCommons crea un Gráfico de conocimiento de los datos que transfiere y, en el proceso, genera interesantes preguntas sobre la calidad y la administración de los datos en el contexto del código abierto. Si me postulo a Google Summer of Docs con una propuesta para la organización DataCommons, espero apoyar y avanzar en estos esfuerzos técnicos en el espacio de datos abiertos de interés público.
Problemas actuales en la documentación con soluciones propuestas Si bien el sitio web dataCommons contiene instrucciones para agregar conjuntos de datos a dataCommons, las indicaciones son muy breves y poco claras, y consisten en varias viñetas que indican que el posible donante de datos utilice el lenguaje de marcado de schema.org. Como parte de este proyecto, propongo borrar la sección "Participar" de dataCommons.org. Crearé un instructivo para agregar nuevos conjuntos de datos y explicar cómo se extraen los conjuntos de datos y cómo se incorporan en el gráfico de conocimiento de dataCommons. También agregaré una sección de Preguntas frecuentes para soluciones comunes sugeridas cuando el propietario de un conjunto de datos se comunica con los encargados de mantenimiento de dataCommons para obtener asistencia.
En cuanto al conjunto actual de ejemplos de consulta de datos, dataCommons solo ofrece cuatro ejemplos de código interactivos, todos ellos notebooks de Python. Como parte de este proyecto, voy a traducir estos {i>notebooks<i} a R y también crearé versiones de demostración interactivas de los ejemplos presentes para Hojas de cálculo de Google y la API de REST, e incorporaré estas demostraciones a la documentación actual.
Por último, la documentación realmente no ofrece ningún ejemplo de cómo se puede usar el gráfico de conocimiento de dataCommons para crear aplicaciones en software. Como parte de este proyecto, crearé, implementaré y documentaré una herramienta de muestra en Python que utiliza la API de dataCommons para permitir que el usuario final cree visualizaciones gráficas relacionadas con dos cantidades conectadas en el gráfico de conocimiento. Por ejemplo, es posible usar esta herramienta para dibujar una regresión lineal relacionada con los datos meteorológicos con información de patrones comerciales comunes. Como objetivo más amplio, espero extender esta herramienta a otros tipos de visualizaciones, como gráficos circulares y diagramas de Venn.
Programación La temporada comienza del 14 de septiembre al 30 de noviembre, por lo que mi plan para completar este proyecto se ve así:
Septiembre: Comienza por reescribir la sección Participar; termina la tarea principalmente a fines de septiembre.
Octubre: Concluye la sección Participa y crea las muestras de código interactivas.
Noviembre: Crea la herramienta de visualización de muestra.