Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Data Commons
- Rédacteur technique:
- KilimAnnejaro
- Nom du projet:
- Amélioration de la documentation de démarrage de DataCommons
- Durée du projet:
- Durée standard (trois mois)
Project description
Au cours de ma carrière d'ingénieur logiciel, j'ai souvent ressenti de la frustration lorsque je rejoignais une nouvelle équipe ou un nouveau projet, téléchargeais un dépôt de code, l'exécutais et voyais le logiciel planter alors que des étapes clés manquaient dans la documentation. J'ai rapidement réalisé que je pouvais appliquer ma passion de toujours pour l'écriture et la composition à ces besoins, en créant un environnement de soutien pour les développeurs avec lesquels je travaillais afin de se concentrer sur l'innovation technique et la créativité, plutôt que de résoudre des problèmes avec des réponses connues.
Cette innovation technique et cette créativité sont nécessaires de toute urgence dans de nombreux segments de la société, en particulier pour les responsables gouvernementaux et du secteur à but non lucratif qui cherchent à analyser des ensembles de données dans leurs espaces problématiques. En rendant ces données facilement disponibles en tant que service, DataCommons réduit les barrières à l'entrée pour les analystes qui recherchent des données facilement accessibles et proches du format dont ils ont besoin pour leurs rôles. Pour cela, DataCommons crée un Knowledge Graph des données qu'il ingère, ce qui soulève des questions intéressantes sur la qualité et la gouvernance des données dans le contexte de l'Open Source. En participant au Google Summer of Docs avec une proposition pour l'organisation DataCommons, j'espère soutenir et faire progresser ces efforts techniques dans l'espace des données ouvertes d'intérêt public.
Difficultés actuelles de la documentation avec les solutions proposées Bien que le site Web dataCommons contienne des instructions pour ajouter des ensembles de données à dataCommons, les instructions sont très courtes et peu claires. Plusieurs puces indiquent au futur donateur de données d'utiliser le balisage schema.org. Dans le cadre de ce projet, je propose de nettoyer la section "Participer" de dataCommons.org. Je vais créer un tutoriel pour ajouter de nouveaux ensembles de données, en expliquant comment les ensembles de données sont extraits et intégrés dans le dataCommons Knowledge Graph. J'ajouterai également une section FAQ pour les solutions courantes suggérées lorsqu'un propriétaire d'ensemble de données contacte les responsables de dataCommons pour obtenir de l'aide.
Si l'on considère l'ensemble actuel d'exemples d'interrogation de données, dataCommons ne propose que quatre exemples de code interactifs, tous des notebooks Python. Dans le cadre de ce projet, je vais traduire ces notebooks en R et créer des versions de démonstration interactives des exemples actuels pour Google Sheets et l'API REST, en les intégrant à la documentation actuelle.
Enfin, la documentation n'offre aucun exemple de la façon dont le Knowledge Graph de dataCommons peut être utilisé pour créer des applications logicielles. Dans le cadre de ce projet, je vais créer, déployer et documenter un exemple d'outil en Python qui utilise l'API dataCommons pour permettre à l'utilisateur final de créer des visualisations graphiques reliant deux quantités connectées dans le graphique de connaissances. Par exemple, vous pouvez utiliser cet outil pour créer une régression linéaire reliant les données météorologiques aux informations sur les tendances commerciales courantes. J'espère pouvoir étendre cet outil à d'autres types de visualisations, comme les graphiques circulaires et les diagrammes de Venn.
CalendrierLa saison se déroule du 14 septembre au 30 novembre. Voici mon plan pour mener à bien ce projet:
Septembre: commencez par réécrire la section "S'impliquer". Terminez cette tâche en grande partie d'ici la fin du mois.
Octobre: Terminez la section "Impliquez-vous" et créez les exemples de code interactifs.
Novembre: créer l'outil de visualisation exemple