Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
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 ingeniero de software, me sentí frustrado en repetidas ocasiones por la experiencia de unirme a un equipo o proyecto nuevo, descargar un repositorio de código, ejecutarlo y ver cómo se rompía el software cuando faltaban pasos clave en la documentación. Rápidamente 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. En el proceso, creé 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 y creatividad técnicas son necesarias con urgencia en muchos segmentos de la sociedad, en especial para los líderes del Gobierno y el sector sin fines de lucro que buscan analizar conjuntos de datos en sus espacios de problemas. Cuando 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, plantea preguntas interesantes sobre la calidad y la administración de datos en el contexto de código abierto. Cuando me postulé a Google Summer of Docs con una propuesta para la organización DataCommons, esperaba respaldar 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 de dataCommons contiene instrucciones para agregar conjuntos de datos a dataCommons, las instrucciones son muy breves y poco claras, y consisten en varios puntos que dirigen al posible donante de datos a usar el lenguaje de marcado de schema.org. Como parte de este proyecto, propongo limpiar la sección "Involúcrate" de dataCommons.org. Crearé un instructivo para agregar conjuntos de datos nuevos en el que explicaré cómo se extraen y se incorporan los conjuntos de datos al grafo de conocimiento de dataCommons. También agregaré una sección de Preguntas frecuentes para las soluciones comunes sugeridas cuando el propietario de un conjunto de datos se comunica con los encargados de mantenimiento de dataCommons para obtener asistencia.
Si observas el conjunto actual de ejemplos para consultar datos, dataCommons solo ofrece cuatro ejemplos de código interactivo, todos ellos notebooks de Python. Como parte de este proyecto, traduciré estos notebooks a R y también crearé versiones de demostración interactivas de los ejemplos actuales para Hojas de cálculo de Google y la API de REST, y, además, incorporaré estas demostraciones en la documentación actual.
Por último, la documentación no ofrece ningún ejemplo de cómo se puede usar el gráfico de conocimiento de dataCommons para compilar 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 construya visualizaciones gráficas en relación con dos cantidades conectadas dentro del Gráfico de conocimiento. Por ejemplo, se podría usar esta herramienta para dibujar una regresión lineal que relacione los datos del clima con la información de patrones comerciales comunes. Como objetivo adicional, espero extender esta herramienta a otros tipos de visualizaciones, como gráficos circulares y diagramas de Venn.
Programa La temporada va del 14 de septiembre al 30 de noviembre, por lo que mi plan para completar este proyecto se ve de la siguiente manera:
Septiembre: Comienza por reescribir la sección Participa. Termina este trabajo a fines de septiembre.
Octubre: Se completa la sección Cómo participar y se crean las muestras de código interactivas.
Noviembre: Crea la herramienta de visualización de muestra.