Cette page contient les détails d'un projet de rédaction technique accepté pour 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 DataCommon
- Durée du projet:
- Durée standard (3 mois)
Project description
Au cours de ma carrière d'ingénieure logiciel, je me suis souvent retrouvée frustrée par l'expérience suivante : rejoindre une nouvelle équipe ou un nouveau projet, extraire un dépôt de code, l'exécuter et regarder le logiciel craquer lorsque des étapes clés ne figuraient pas dans la documentation. J'ai rapidement réalisé que je pouvais mettre à profit ma passion de toujours pour l'écriture et la composition pour répondre à ces besoins, en créant un environnement favorable aux développeurs avec lesquels j'ai travaillé pour qu'ils puissent se concentrer sur l'innovation technique et la créativité, plutôt que sur la résolution de problèmes avec des réponses connues.
Cette créativité technique et cette innovation technique sont nécessaires de toute urgence dans de nombreux segments de la société, en particulier par les responsables de gouvernement et les organisations à but non lucratif qui cherchent à analyser des ensembles de données dans leurs zones de problèmes. En rendant ces données facilement accessibles en tant que service, DataCommons réduit les obstacles à l'entrée pour les analystes à la recherche de données faciles d'accès et proches du format dont ils ont besoin pour leurs fonctions. Pour ce faire, DataCommons crée un Knowledge Graph à partir des données ingérées, 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 postulant pour Google Summer of Docs et en soumettant une proposition pour l'organisation DataCommons, j'espère soutenir et faire avancer ces efforts techniques dans l'espace de données ouvertes d'intérêt public.
Difficultés actuelles dans 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, et se composent de plusieurs puces indiquant au donneur de données potentiel d'utiliser le balisage schema.org. Dans le cadre de ce projet, je propose de nettoyer la section « Impliquer » de dataCommons.org. Je vais créer un tutoriel pour ajouter de nouveaux ensembles de données, en expliquant comment ils sont détournés et intégrés au Knowledge Graph dataCommons. J'ajouterai également une section FAQ pour les solutions courantes suggérées lorsqu'un propriétaire d'un ensemble de données demande de l'aide aux responsables de dataCommons.
Si l'on considère l'ensemble actuel d'exemples pour interroger des 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 langage R et créer également des versions de démonstration interactives des exemples actuels pour Google Sheets et l'API REST, en intégrant ces démonstrations dans la documentation actuelle.
Enfin, la documentation ne fournit pas vraiment d'exemples d'utilisation du dataCommons Knowledge Graph pour créer des applications dans des logiciels. 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 concernant deux quantités connectées au sein du Knowledge Graph. Par exemple, cet outil pourrait permettre de tracer une régression linéaire associant des données météorologiques aux informations courantes sur les tendances commerciales. Comme un objectif ambitieux, j'espère étendre cet outil à d'autres types de visualisations, tels que les graphiques à secteurs et les diagrammes de Venn.
Calendrier La saison dure du 14 septembre au 30 novembre, donc mon plan pour terminer ce projet ressemble à ceci:
Septembre: commencez par réécrire la section "Impliquez-vous" et terminez généralement ce travail avant la fin du mois de septembre.
Octobre: concluez la section "Impliquez-vous" et créez les exemples de code interactifs.
Novembre: créer l'exemple d'outil de visualisation.